Edit

Share via

EapHostPeerInvokeConfigUI function (eaphostpeerconfigapis.h)

  • Article

Starts the configuration user interface of the specified EAP method.

EapHostPeerInvokeConfigUI must be called on threads that have COM initialized for Single Threaded Apartment (STA). 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 EapHostPeerInvokeConfigUI(
  [in]  HWND            hwndParent,
  [in]  DWORD           dwFlags,
  [in]  EAP_METHOD_TYPE eapMethodType,
  [in]  DWORD           dwSizeOfConfigIn,
  [in]  const BYTE      *pConfigIn,
  [out] DWORD           *pdwSizeOfConfigOut,
  [out] BYTE            **ppConfigOut,
  [out] EAP_ERROR       **ppEapError
);

Parameters

[in] hwndParent

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

[in] dwFlags

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

[in] eapMethodType

An EAP_METHOD_TYPE structure that specifies the EAP method.

[in] dwSizeOfConfigIn

The size of input configuration. May be set to 0 (zero).

[in] pConfigIn

A pointer to a byte buffer that contains configuration elements. The buffer is of size dwSizeOfConfigIn. This parameter can be NULL, if dwSizeOfConfigIn is set to 0 (zero).

[out] pdwSizeOfConfigOut

A pointer to a DWORD that specifies the size of the buffer pointed to by ppConfigOut.

[out] ppConfigOut

A pointer to a pointer to a byte buffer that contains updated configuration data from the user. After consuming the data, this memory must be freed by calling EapHostPeerFreeMemory.

[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

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

See also

EAPHost Supplicant Configuration Functions