NAME

CSP_Login

SYNOPSIS

CSSM_RETURN CSSMSPI CSP_Login
    (CSSM_CSP_HANDLE CSPHandle,
    const CSSM_CRYPTO_DATA_PTR Password,
    const CSSM_DATA_PTR Reserved)

DESCRIPTION

Logs the user into the CSP, allowing for multiple login types and parallel operation notification.

PARAMETERS

CSPHandle (input)

Handle of the CSP to log into.

Password (input)

Password used to log into the token.

Reserved (input)

This field is reserved for future use. The value NULL should always be given. (May be used for multiple user support in the future.)

RETURN VALUE

CSSM_OK if login is successful, CSSM_FAIL is login fails. Use CSSM_GetError to determine the exact error.

ERRORS

CSSM_CSP_INVALID_CSP_HANDLE

Invalid CSP handle.

CSSM_CSP_MEMORY_ERROR

Not enough memory to allocate.

CSSM_CSP_INVALID_PASSWORD

Invalid password.

CSSM_CSP_ALREADY_LOGGED_IN

User attempted to log in more than once.

CSSM_CSP_OPERATION_UNSUPPORTED

Login service not supported.

SEE ALSO

CSP_ChangeLoginPassword, CSP_Logout