SpGetCredUIContextFn callback function (ntsecpkg.h)

Article
02/22/2024

Retrieves context information from a credential provider.

Syntax

SpGetCredUIContextFn Spgetcreduicontextfn;

NTSTATUS Spgetcreduicontextfn(
  [in]  LSA_SEC_HANDLE ContextHandle,
  [in]  GUID *CredType,
  [out] PULONG FlatCredUIContextLength,
  [out] PUCHAR *FlatCredUIContext
)
{...}

Parameters

[in] ContextHandle

A handle to the context for which to get information.

[in] CredType

The type of credential specified by the ContextHandle parameter. This can be one of the following values.

Value	Meaning
SEC_WINNT_AUTH_DATA_TYPE_PASSWORD 0x28bfc32f, 0x10f6, 0x4738, 0x98, 0xd1, 0x1a, 0xc0, 0x61, 0xdf, 0x71, 0x6a	The credential is a password.
SEC_WINNT_AUTH_DATA_TYPE_CERT 0x235f69ad, 0x73fb, 0x4dbc, 0x82, 0x3, 0x6, 0x29, 0xe7, 0x39, 0x33, 0x9b	The credential is a certificate.
SEC_WINNT_AUTH_DATA_TYPE_CSP_DATA 0x68fd9879, 0x79c, 0x4dfe, 0x82, 0x81, 0x57, 0x8a, 0xad, 0xc1, 0xc1, 0x0	The credential is authentication data from a cryptographic service provider (CSP).

[out] FlatCredUIContextLength

The size, in characters, of the buffer received by the FlatCredUIContext parameter.

[out] FlatCredUIContext

A pointer to an array of characters that specifies information about the context specified by the ContextHandle parameter.

Return value

If the function succeeds, return STATUS_SUCCESS or an informational status code.

If the function fails, return an NTSTATUS error code that indicates the reason it failed. For more information, see Remarks.

Remarks

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

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	ntsecpkg.h

Share via