SpCompleteAuthTokenFn callback function (ntsecpkg.h)

The SpCompleteAuthToken function completes an authentication token.

The SpCompleteAuthToken function is the dispatch function for the CompleteAuthToken function of the Security Support Provider Interface.

Syntax

SpCompleteAuthTokenFn Spcompleteauthtokenfn;

NTSTATUS Spcompleteauthtokenfn(
  [in] LSA_SEC_HANDLE ContextHandle,
  [in] PSecBufferDesc InputBuffer
)
{...}

Parameters

[in] ContextHandle

Handle of the context to complete.

[in] InputBuffer

Pointer to a SecBufferDesc structure that contains package-specific information for the context.

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

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

See also

CompleteAuthToken

SECPKG_USER_FUNCTION_TABLE

SpUserModeInitialize