EapPeerInvokeInteractiveUI function (eapmethodpeerapis.h)

Article
10/13/2021

Raises a custom interactive user interface dialog for the EAP method on the client.

Syntax

DWORD EapPeerInvokeInteractiveUI(
  [in]  EAP_METHOD_TYPE *pEapType,
  [in]  HWND            hwndParent,
  [in]  DWORD           dwSizeofUIContextData,
  [in]  BYTE            *pUIContextData,
  [out] DWORD           *pdwSizeOfDataFromInteractiveUI,
  [out] BYTE            **ppDataFromInteractiveUI,
  [out] EAP_ERROR       **ppEapError
);

Parameters

[in] pEapType

An EAP_METHOD_TYPE structure that contains vendor and author information about the EAP method used for authenticating the connection.

[in] hwndParent

A handle to the parent window which will spawn the interactive user interface dialog.

[in] dwSizeofUIContextData

The size, in bytes, of the user interface context data specified by pUIContextData.

[in] pUIContextData

A pointer to an opaque byte buffer that contains the context data used to create the user interface dialog.

[out] pdwSizeOfDataFromInteractiveUI

A pointer to the size, in bytes, of the data returned in ppDataFromInteractiveUI.

[out] ppDataFromInteractiveUI

A pointer to the address of an opaque byte buffer that contains data obtained from the interactive user interface dialog.

[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 callingEapPeerFreeErrorMemory.

Return value

None

Remarks

This API is used when EAPHost must obtain specific data from the user to continue.

This call is performed by a peer-based EAPHost using a function pointer to this API. This API must be implemented on the EAP method loaded by EAPHost, and must strictly conform to the syntax and parameter types specified in the documentation.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	eapmethodpeerapis.h