SpFormatCredentialsFn callback function (ntsecpkg.h)

Article
02/22/2024

Formats credentials to be stored in a user object.

Syntax

SpFormatCredentialsFn Spformatcredentialsfn;

NTSTATUS Spformatcredentialsfn(
  [in]  PSecBuffer Credentials,
  [out] PSecBuffer FormattedCredentials
)
{...}

Parameters

[in] Credentials

Pointer to a SecBuffer structure containing the credentials to be formatted.

[out] FormattedCredentials

Pointer to a SecBuffer structure containing the formatted credentials. Allocate memory for the structure using the AllocateHeap function.

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 SpFormatCredentials function; however, the actual name given to the implementation is up to the developer.

A pointer to the SpFormatCredentials function is available in the SECPKG_USER_FUNCTION_TABLE structure received from the SpUserModeInitialize 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