EapHostPeerInvokeInteractiveUI function (eaphostpeerconfigapis.h)

Article
10/13/2021

Raises an interactive user interface used to get 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 EapHostPeerInvokeInteractiveUI(
  [in]  HWND       hwndParent,
  [in]  DWORD      dwSizeofUIContextData,
  [in]  const BYTE *pUIContextData,
  [out] DWORD      *pdwSizeOfDataFromInteractiveUI,
  [out] BYTE       **ppDataFromInteractiveUI,
  [out] EAP_ERROR  **ppEapError
);

Parameters

[in] hwndParent

The handle of the parent window under which configuration dialog appears.

[in] dwSizeofUIContextData

The size, in bytes, of the buffer pointed to by the pUIContextData parameter.

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

[out] pdwSizeOfDataFromInteractiveUI

A pointer to a DWORD that represents the size, in bytes, of the buffer pointed to by the ppDataFromInteractiveUI parameter.

[out] 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 consuming the data, this memory must be freed by calling EapHostPeerFreeMemory. The buffer is of size pdwSizeofDataFromInteractiveUI.

[out] 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 consuming the error data, this memory must be freed by calling EapHostPeerFreeErrorMemory.

Return value

None

Remarks

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

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	eaphostpeerconfigapis.h
Library	Eappcfg.lib
DLL	Eappcfg.dll

Share via