EapHostPeerInvokeIdentityUI function

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.


DWORD WINAPI 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,
  _Inout_  DWORD *pdwSizeofUserDataOut,
  _Out_    BYTE **ppUserDataOut,
  _Out_    LPWSTR *ppwszIdentity,
  _Out_    EAP_ERROR **ppEapError,
  _Inout_  LPVOID *ppvReserved


dwVersion [in]

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

eapMethodType [in]

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

dwFlags [in]

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

hwndParent [in]

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

dwSizeofConnectionData [in]

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

pConnectionData [in]

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

dwSizeofUserData [in]

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

pUserData [in]

Pointer to user credential information that pertains to this authentication.

pdwSizeofUserDataOut [in, out]

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

ppUserDataOut [out]

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.

ppwszIdentity [out]

A pointer to a NULL-terminated user identity string. After use, this memory must be freed by calling EapHostPeerFreeMemory.

ppEapError [out]

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.

ppvReserved [in, out]

Reserved for future use.


Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]







See also

EAPHost Supplicant Configuration Functions



Community Additions

© 2015 Microsoft