SpFreeCredentialsHandleFn callback function (ntsecpkg.h)

Article
02/22/2024

Frees credentials acquired by calling the SpAcquireCredentialsHandle function.

Syntax

SpFreeCredentialsHandleFn Spfreecredentialshandlefn;

NTSTATUS Spfreecredentialshandlefn(
  [in] LSA_SEC_HANDLE CredentialHandle
)
{...}

Parameters

[in] CredentialHandle

A handle to the credentials to free.

Return value

If the function succeeds, return STATUS_SUCCESS.

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

Return code	Description
SEC_E_INVALID_HANDLE	The handle is not valid.

Remarks

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

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

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	ntsecpkg.h