SpDeleteCredentialsFn callback function (ntsecpkg.h)

Article
10/13/2021

Deletes credentials from a security package's list of primary or supplemental credentials.

Syntax

SpDeleteCredentialsFn Spdeletecredentialsfn;

NTSTATUS Spdeletecredentialsfn(
  [in] LSA_SEC_HANDLE CredentialHandle,
  [in] PSecBuffer Key
)
{...}

Parameters

[in] CredentialHandle

A handle to the credentials to delete.

[in] Key

Pointer to a SecBuffer structure whose contents indicate which credentials to delete. The information stored in the Key parameter is package specific.

Return value

If the function succeeds, return STATUS_SUCCESS.

If the function fails, return an NTSTATUS code that indicates the reason it failed.

Remarks

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

A pointer to the SpDeleteCredentials 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