EapHostPeerQueryUIBlobFromInteractiveUIInputFields function

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


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


dwVersion [in]

The version number of the API.


The version of the EAPHost Peer APIs.


dwFlags [in]

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

dwSizeofUIContextData [in]

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

pUIContextData [in]

Pointer to a BLOB that contains UI context data, represented as inner pointers to field data. These inner pointers must be freed by passing them to EapHostPeerFreeMemory, starting with the innermost pointer.

pEapInteractiveUIData [in]

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

pdwSizeOfDataFromInteractiveUI [in, out]

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

ppDataFromInteractiveUI [in, out]

Pointer that receives a credentials BLOB that can be used in authentication. The caller should free the inner pointers using the function EapHostPeerFreeMemory, 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. If a non-NULL BLOB value is supplied, the LocalAlloc function should be used.

ppEapError [out]

A pointer to a pointer to 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 EapHostPeerFreeErrorMemory.

ppvReserved [in, out]

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


EapHostPeerQueryUIBlobFromInteractiveUIInputFields can be employed to support Single-Sign-On (SSO). In an SSO scenario, EapHostPeerQueryUIBlobFromInteractiveUIInputFields is the last API to be called before resuming a regular call sequence. For more information, see Supplicant 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