EapHostPeerQueryInteractiveUIInputFields function

The EapHostPeerQueryInteractiveUIInputFields function obtains the input fields for interactive UI components to be raised on the supplicant.

Syntax


DWORD WINAPI EapHostPeerQueryInteractiveUIInputFields(
  _In_     DWORD dwVersion,
  _In_     DWORD dwFlags,
  _In_     DWORD dwSizeofUIContextData,
  _In_     const BYTE *pUIContextData,
  _Out_    EAP_INTERACTIVE_UI_DATA *pEapInteractiveUIData,
  _Out_    EAP_ERROR **ppEapError,
  _Inout_  LPVOID *ppvReserved
);

Parameters

dwVersion [in]

The version number of the API.

ValueMeaning
EAPHOST_PEER_API_VERSION
1

The version of the EAPHost peer API.

 

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 [out]

Pointer that receives an EAP_INTERACTIVE_UI_DATA structure that contains configuration information for interactive UI components raised on an EAP supplicant. The caller should free the inner pointers using the function EapHostPeerFreeMemory, starting at the innermost pointer.

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.

Remarks

EapHostPeerQueryInteractiveUIInputFields can be employed to support Single-Sign-On (SSO). The supplicant uses the EAP_FLAG_PRE_LOGON flag in EapHostPeerBeginSession to indicate to EAPHost that SSO should be provided. If the EapHostPeerResponseInvokeUI action code is received after calling EapHostPeerBeginSession, EAPHost then calls EapHostPeerQueryInteractiveUIInputFields, and later calls EapHostPeerQueryUIBlobFromInteractiveUIInputFields.

The supplicant should call the EapHostPeerQueryInteractiveUIInputFields function first after receiving the EapHostPeerResponseInvokeUI action code from EAPHost. If the EapHostPeerResponseInvokeUI action code isn't returned, or if EAP_E_EAPHOST_METHOD_OPERATION_NOT_SUPPORTED is returned, the supplicant should resort to the traditional model of invoking method interactive UI by calling EapHostPeerInvokeInteractiveUI. If there is an error, EapHostPeerQueryInteractiveUIInputFields will return a return code other than NULL.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Eaphostpeerconfigapis.h

Library

Eappcfg.lib

DLL

Eappcfg.dll

See also

EAPHost Supplicant Configuration Functions
SSO and PLAP

 

 

Community Additions

ADD
Show:
© 2014 Microsoft