EapPeerInvokeConfigUI function (eapmethodpeerapis.h)

Article
10/13/2021

Raises the EAP method's specific connection configuration user interface dialog on the client.

Syntax

DWORD EapPeerInvokeConfigUI(
  [in]  EAP_METHOD_TYPE *pEapType,
  [in]  HWND            hwndParent,
  [in]  DWORD           dwFlags,
  [in]  DWORD           dwSizeOfConnectionDataIn,
  [in]  BYTE            *pConnectionDataIn,
  [out] DWORD           *pdwSizeOfConnectionDataOut,
  [out] BYTE            **ppConnectionDataOut,
  [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 connection configuration user interface dialog.

[in] dwFlags

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

[in] dwSizeOfConnectionDataIn

Specifies the size, in bytes, of the pConnectionDataIn buffer.

[in] pConnectionDataIn

A pointer to the connection data specific to this authentication used to pre-populate the configuration user interface. When this API is called for the first time, or when a new authentication session starts, this parameter is NULL.

[out] pdwSizeOfConnectionDataOut

Receives a pointer to the size, in bytes, of the ppConnectionDataOut parameter.

[out] ppConnectionDataOut

Receives a pointer to a pointer that contains a byte buffer with the user-configured connection data.

[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 calling EapPeerFreeErrorMemory.

Return value

None

Remarks

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