EapHostPeerQueryInteractiveUIInputFields (Compact 7)
3/12/2014
This 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
The version number of the API.
| Value | Meaning |
|---|---|
EAPHOST_PEER_API_VERSION 1 |
The version of the EAPHost peer API. |
- 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
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
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 by using the function EapHostPeerFreeMemory, starting at the innermost pointer.
- ppEapError
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 using the error data, this memory must be freed by calling EapHostPeerFreeErrorMemory.
- ppvReserved
Reserved; set to 0 (zero).
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 EapHostPeerResponseAction action code is received after it calls EapHostPeerBeginSession, EAPHost then calls EapHostPeerQueryInteractiveUIInputFields, and later calls EapHostPeerQueryUIBlobFromInteractiveUIInputFields.
The supplicant should call the EapHostPeerQueryInteractiveUIInputFields function first after it receives the EapHostPeerResponseInvokeUI action code from EAPHost. If the EapHostPeerResponseInvokeUI action code is not returned, or if EAP Related Error and Information Constants is returned, the supplicant should rely on 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.