EapPeerQueryUIBlobFromInteractiveUIInputFields function

The EapPeerQueryUIBlobFromInteractiveUIInputFields function converts user information into a user BLOB that can be consumed by EAPHost run-time functions.


DWORD WINAPI EapPeerQueryUIBlobFromInteractiveUIInputFields(
  _In_          DWORD                   dwVersion,
  _In_          DWORD                   dwFlags,
  _In_          DWORD                   dwSizeofUIContextData,
  _In_    const BYTE                    *pUIContextData,
  _In_    const EAP_INTERACTIVE_UI_DATA *pEapInteractiveUIData,
  _Out_         DWORD                   *pdwSizeOfDataFromInteractiveUI,
  _Out_         BYTE                    **ppDataFromInteractiveUI,
  _Out_         EAP_ERROR               **ppEapError,
  _Inout_       LPVOID                  *ppvReserved


dwVersion [in]

The version number of the API. Must be set to zero.

dwFlags [in]

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

dwSizeofUIContextData [in]

The size of the context data in the pUIContextData parameter, in bytes.

pUIContextData [in]

A pointer to a BLOB that contains UI context data, represented as inner pointers to field data. The supplicant obtained these inner pointers from EAPHost run-time functions.

pEapInteractiveUIData [in]

Pointer that receives an EAP_INTERACTIVE_UI_DATA structure that contains configuration information for interactive user interface components raised on an EAP supplicant.

pdwSizeOfDataFromInteractiveUI [out]

A pointer to a DWORD that specifies the size of the buffer pointed to by the ppDataFromInteractiveUI parameter, in bytes. If this value is not set to 0, then a pointer to a buffer of the size specified in this parameter must be supplied in the ppDataFromInteractiveUI parameter.

ppDataFromInteractiveUI [out]

A pointer that receives a credentials BLOB that can be used in authentication. The caller should free the inner pointers using the function EapPeerFreeMemory, starting at the innermost pointer. If a non-NULL value is supplied for this parameter, meaning that an existing data BLOB is passed to it, the supplied data BLOB will be updated and returned in this parameter.

ppEapError [out]

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

ppvReserved [in, out]

Reserved for future use. This parameter must be set to 0.


EapPeerQueryUIBlobFromInteractiveUIInputFields can be employed to support Single-Sign-On (SSO). In an SSO scenario, EapPeerQueryUIBlobFromInteractiveUIInputFields is the last API to be called before resuming a regular call sequence. For more information, see Peer Method API Call Sequence.


Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]



See also

EAPHost Supplicant Configuration Functions



Community Additions