Share via

EapPeerQueryInteractiveUIInputFields (Compact 7)

  • Article

3/12/2014

This function defines the implementation of an EAP method API that provides the input fields for interactive UI components to be raised on the supplicant.

Syntax

DWORD WINAPI EapPeerQueryInteractiveUIInputFields(
  __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* pvReserved
);

Parameters

  • dwVersion
    The version number of the API. Must be set to zero.
  • dwFlags
    A combination of EAP Method Flags that describe the EAP authentication session behavior.
  • dwSizeofUIContextData
    The size of the context data in pUIContextData, in bytes.
  • pUIContextData
    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 APIs.
  • pEapInteractiveUIData
    Pointer that receives an EAP_INTERACTIVE_UI_DATA structure that contains configuration information for interactive UI components raised on an EAP supplicant.
  • ppEapError
    A pointer to the address of an EAP_ERROR structure that contains any errors raised during the execution of this function call. After using the error data, this memory must be freed by passing a pointer to the error data to EapPeerFreeErrorMemory.
  • pvReserved
    Reserved. Set to NULL.

Remarks

EapPeerQueryInteractiveUIInputFields can be employed to support Single-Sign-On (SSO). The EAP_FLAG_PRE_LOGON flag in EapPeerBeginSession indicates to EAPHost that SSO should be provided. If the EapPeerResponseInvokeUI action code is received after the code calls EapPeerBeginSession, EAPHost then calls EapPeerQueryInteractiveUIInputFields, and then later calls EapPeerQueryUIBlobFromInteractiveUIInputFields.

The supplicant should call always call the EapPeerQueryInteractiveUIInputFields function first after it receives the EapPeerResponseInvokeUI action code from EAPHost. If the EapPeerResponseInvokeUI action code isn't returned, or if EAP Related Error and Information Constants is returned, the supplicant should resort to the traditional model of invoking method interactive UI by calling EapPeerInvokeInteractiveUI. If there is an error, EapPeerQueryInteractiveUIInputFields will return a return code other than NULL.

See Also

Reference

EAPHost Peer Method Configuration Functions
EAP_CONFIG_INPUT_FIELD_ARRAY