EapPeerQueryInteractiveUIInputFields function (eapmethodpeerapis.h)

The EapPeerQueryInteractiveUIInputFields 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 EapPeerQueryInteractiveUIInputFields(
  [in]      DWORD                   dwVersion,
  [in]      DWORD                   dwFlags,
  [in]      DWORD                   dwSizeofUIContextData,
  [in]      const BYTE              *pUIContextData,
  [out]     EAP_INTERACTIVE_UI_DATA *pEapInteractiveUIData,
  [out]     EAP_ERROR               **ppEapError,
  [in, out] LPVOID                  *ppvReserved
);

Parameters

[in] dwVersion

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

[in] dwFlags

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

[in] dwSizeofUIContextData

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

[in] 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.

[out] pEapInteractiveUIData

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

[out] ppEapError

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.

[in, out] ppvReserved

Reserved for future usage. Must be set to NULL

Return value

None

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 calling EapPeerBeginSession, EAPHost then calls EapPeerQueryInteractiveUIInputFields, and later calls EapPeerQueryUIBlobFromInteractiveUIInputFields.

The supplicant should call always call the EAP_E_EAPHOST_METHOD_OPERATION_NOT_SUPPORTED 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.

Requirements

See also

EAP_CONFIG_INPUT_FIELD_ARRAY

SSO and PLAP