Share via

EapHostPeerInvokeInteractiveUI (Compact 7)

  • Article

3/12/2014

This function raises an interactive user interface that is used to obtain credentials from the user. For example, this function can be used to raise a UI that retrieves credentials from a smart card, and prompts the user to enter the corresponding PIN.

EapHostPeerInvokeInteractiveUI must be called on threads that have COM initialized for Single Threaded Apartment. This can be achieved by calling COM API CoInitialize; when the supplicant has finished with the STA thread CoUninitialize must be called before exiting.

Syntax

DWORD WINAPI EapHostPeerInvokeInteractiveUI(
  __in   HWND hwndParent,
  __in   DWORD dwSizeofUIContextData,
  __in   const BYTE* pUIContextData,
  __out  DWORD* pdwSizeofDataFromInteractiveUI,
  __out  BYTE** ppDataFromInteractiveUI,
  __out  EAP_ERROR** ppEapError
);

Parameters

  • hwndParent
    The handle of the parent window under which configuration dialog appears.
  • dwSizeofUIContextData
    The size, in bytes, of the buffer pointed to by the pUIContextData parameter.
  • pUIContextData
    A pointer to a buffer that contains the supplicant UI context data from EAPHost. The context data is returned by EapHostPeerGetUIContext. The buffer is of size dwSizeOfUIContextData.
  • pdwSizeofDataFromInteractiveUI
    A pointer to a DWORD that represents the size, in bytes, of the buffer pointed to by the ppDataFromInteractiveUI parameter.
  • ppDataFromInteractiveUI
    A pointer to a pointer to a byte buffer that contains data from the interactive UI necessary for authentication to continue. The parameter ppDataFromInteractiveUI should be passed to EapHostPeerSetUIContext as the IN parameter pUIContextData. After using the data, this memory must be freed by calling EapHostPeerFreeMemory. The buffer is of size pdwSizeofDataFromInteractiveUI.
  • 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.

Remarks

The supplicant should call EapHostPeerQueryInteractiveUIInputFields function first after it receives the EapHostPeerResponseAction action code from EAPHost. If EAP Related Error and Information Constantsis returned, the supplicant should rely on the traditional model of invoking method interactive UI by calling EapHostPeerInvokeInteractiveUI.

If called,EapHostPeerInvokeInteractiveUI raises the user interface for the EAP method after the supplicant calls EapHostPeerGetUIContext. This occurs when a call to EapHostPeerProcessReceivedPacket returns the EapHostPeerResponseInvokeUi action code. EapHostPeerGetUIContext returns UI context that the supplicant then passes to EapHostPeerInvokeInteractiveUI to raise the UI.

See Also

Reference

EAPHost Supplicant Configuration Functions
EapHostPeerGetUIContext
EapHostPeerSetUIContext
EapHostPeerQueryInteractiveUIInputFields