Edit

Share via

SspiGetCredUIContext function (sspi.h)

  • Article

Retrieves context information from a credential provider.

Syntax

SECURITY_STATUS SEC_ENTRY SspiGetCredUIContext(
  [in]  HANDLE                           ContextHandle,
  [in]  GUID                             *CredType,
  [in]  LUID                             *LogonId,
  [out] PSEC_WINNT_CREDUI_CONTEXT_VECTOR *CredUIContexts,
  [out] HANDLE                           *TokenHandle
);

Parameters

[in] ContextHandle

A pointer to a SEC_WINNT_CREDUI_CONTEXT structure retrieved during a previous call to the SspiUnmarshalCredUIContext function.

[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).

[in] LogonId

The logon ID associated with the credential specified by the ContextHandle parameter.

The caller must be running as LocalSystem to specify a logon ID.

[out] CredUIContexts

A pointer to a SEC_WINNT_CREDUI_CONTEXT_VECTOR structure that specifies the offset and size of the data in the structure specified by the ContextHandle parameter.

[out] TokenHandle

A handle to the specified user's token.

Return value

If the function succeeds, it returns SEC_E_OK.

If the function fails, it returns a nonzero error code.

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 sspi.h
Library Credui.lib
DLL Credui.dll