EapHostPeerInvokeIdentityUI function (eaphostpeerconfigapis.h)

This function is called by tunnel methods to invoke the identity UI of the inner methods. This function returns the identity as well as credentials to use in order to start the authentication.

Syntax

DWORD EapHostPeerInvokeIdentityUI(
  [in]      DWORD           dwVersion,
  [in]      EAP_METHOD_TYPE eapMethodType,
  [in]      DWORD           dwFlags,
  [in]      HWND            hwndParent,
  [in]      DWORD           dwSizeofConnectionData,
  [in]      const BYTE      *pConnectionData,
  [in]      DWORD           dwSizeofUserData,
  [in]      const BYTE      *pUserData,
  [in, out] DWORD           *pdwSizeOfUserDataOut,
  [out]     BYTE            **ppUserDataOut,
  [out]     LPWSTR          *ppwszIdentity,
  [out]     EAP_ERROR       **ppEapError,
  [in, out] LPVOID          *ppvReserved
);

Parameters

[in] dwVersion

The version number of the API. Must be set to zero.

[in] eapMethodType

An EAP_METHOD_TYPE structure that specifies the type of EAP authentication to use for this session.

[in] dwFlags

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

[in] hwndParent

Handle of the parent window under which the configuration dialog will show up.

[in] dwSizeofConnectionData

Size of the buffer indicated by the pConnectionData parameter, in bytes.

[in] pConnectionData

Pointer to configuration data that is used for the EAP method.

[in] dwSizeofUserData

Size of the buffer indicated by the pUserData parameter, in bytes.

[in] pUserData

Pointer to user credential information that pertains to this authentication.

[in, out] pdwSizeOfUserDataOut

Size of the buffer set to receive the user data returned by the ppUserDataOut parameter, in bytes.

[out] ppUserDataOut

A pointer to a pointer to a buffer that contains user data information returned by the method. After use, this memory must be freed by calling EapHostPeerFreeMemory.

[out] ppwszIdentity

A pointer to a NULL-terminated user identity string. After use, 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 during the execution of this function call. After consuming the error data, this memory must be freed by calling EapHostPeerFreeErrorMemory.

[in, out] ppvReserved

Reserved for future use.

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