SpGetCredentials function

The SpGetCredentials function retrieves the primary and supplemental credentials from the user object.

Syntax


NTSTATUS SpGetCredentials(
  _In_  LSA_SEC_HANDLE CredentialHandle,
  _Out_ PSecBuffer     Credentials
);

Parameters

CredentialHandle [in]

A handle to the credentials to be retrieved.

Credentials [out]

Pointer to a SecBuffer structure that receives the credentials.

Return value

If the function succeeds, return STATUS_SUCCESS.

If the function fails, return an NTSTATUS code indicating the reason it failed. The following lists common reasons for failure and the error codes that the function should return.

Return codeDescription
SEC_E_INSUFFICIENT_MEMORY

There is not sufficient memory to retrieve the credentials.

SEC_E_INVALID_HANDLE

The handle is not valid.

 

Remarks

SSP/APs must implement the SpGetCredentials function; however, the actual name given to the implementation is up to the developer.

A pointer to the SpGetCredentials function is available in the SECPKG_FUNCTION_TABLE structure received from the SpLsaModeInitialize function.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Ntsecpkg.h

See also

SECPKG_FUNCTION_TABLE
SpLsaModeInitialize

 

 

Show: