Edit

SpApplyControlTokenFn callback function (ntsecpkg.h)

  • Article

Applies a control token to a security context. This function is not currently called by the Local Security Authority (LSA).

Syntax

SpApplyControlTokenFn Spapplycontroltokenfn;

NTSTATUS Spapplycontroltokenfn(
  [in] LSA_SEC_HANDLE ContextHandle,
  [in] PSecBufferDesc ControlToken
)
{...}

Parameters

[in] ContextHandle

A handle to the security context to be modified based on the ControlToken parameter.

[in] ControlToken

Pointer to a SecBufferDesc structure containing the token to apply to 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 common reasons for failure and the error codes that the function should return.

Return code Description
SEC_E_INVALID_TOKEN
 The token is not valid.
SEC_E_INVALID_HANDLE
 The handle is not valid.

Remarks

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

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

See also

SECPKG_FUNCTION_TABLE

SpLsaModeInitialize