EapPeerQueryUserBlobFromCredentialInputFields function

The EapPeerQueryUserBlobFromCredentialInputFields function defines the implementation of an EAP method function that obtains the user BLOB data provided in an interactive Single-Sign-On (SSO) UI raised on the supplicant.


DWORD WINAPI EapPeerQueryUserBlobFromCredentialInputFields(
  _In_          HANDLE                       hUserImpersonationToken,
  _In_          EAP_METHOD_TYPE              eapMethodType,
  _In_          DWORD                        dwFlags,
  _In_          DWORD                        dwEapConnDataSize,
  _In_          BYTE                         *pbEapConnData,
  _In_    const EAP_CONFIG_INPUT_FIELD_ARRAY *pEapConfigInputFieldArray,
  _Inout_       DWORD                        *pdwUsersBlobSize,
  _Inout_       BYTE                         **ppUserBlob,
  _Out_         EAP_ERROR                    **ppEapError


hUserImpersonationToken [in]

An impersonation token for the user whose credentials are to be requested and obtained.

eapMethodType [in]

An EAP_METHOD_TYPE structure that contains vendor and author information about the EAP method used for authenticating the connection.

dwFlags [in]

A combination of EAP flags that describe the EAP authentication session behavior.

dwEapConnDataSize [in]

The size of the EAP SSO configuration data pointed to by pbEapConnData, in bytes.

pbEapConnData [in]

A pointer to an opaque byte buffer that contains the EAP SSO configuration data BLOB.

pEapConfigInputFieldArray [in]

A pointer to an EAP_CONFIG_INPUT_FIELD_ARRAY structure that contains the input fields to display to the supplicant user. The pwszData fields in the individual EAP_CONFIG_INPUT_FIELD_DATA elements are initialized to NULL.

pdwUsersBlobSize [in, out]

A pointer to a buffer that contains the size, in bytes, of the opaque user configuration data BLOB in ppUserBlob.

ppUserBlob [in, out]

A pointer that contains the opaque user data BLOB.

ppEapError [out]

A pointer to the address of an EAP_ERROR structure that contains any errors raised during the execution of this function call. After consuming the error data, this memory must be freed by passing a pointer to the error data to EapPeerFreeErrorMemory.


EapPeerQueryUserBlobFromCredentialInputFields supports Single-Sign-On (SSO). This peer method function, like EapPeerQueryCredentialInputFields, is used only in an SSO scenario.

After EapPeerQueryUserBlobFromCredentialInputFields, EAPHost calls EapPeerBeginSession. The supplicant uses the EAP_FLAG_PRE_LOGON flag in EapHostPeerBeginSession to indicate that EAPHost should provide SSO.


Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]



See also




Community Additions