EapHostPeerGetIdentity function

This function is called by tunnel methods to request identity information from the inner methods. This function returns the identity and user credential information.

Syntax


DWORD WINAPI EapHostPeerGetIdentity(
  _In_          DWORD           dwVersion,
  _In_          DWORD           dwFlags,
  _In_          EAP_METHOD_TYPE eapMethodType,
  _In_          DWORD           dwSizeofConnectionData,
  _In_    const BYTE            *pConnectionData,
  _In_          DWORD           dwSizeofUserData,
  _In_    const  BYTE           *pUserData,
  _In_          HANDLE          hTokenImpersonateUser,
  _Out_         BOOL            *pfInvokeUI,
  _Inout_       DWORD           *pdwSizeofUserDataOut,
  _Out_         BYTE            **ppUserDataOut,
  _Out_         LPWSTR          *ppwszIdentity,
  _Out_         EAP_ERROR       **ppEapError,
  _Inout_       BYTE            **ppvReserved
);

Parameters

dwVersion [in]

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

dwFlags [in]

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

eapMethodType [in]

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

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 session.

hTokenImpersonateUser [in]

Impersonation token for a logged-on user to collect user-related information.

pfInvokeUI [out]

Returns TRUE if the user identity and user data blob aren't returned successfully, and the method seeks to collect the information from the user through the user interface dialog.

pdwSizeofUserDataOut [in, out]

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

ppUserDataOut [out]

User data information returned by the method. After use, this memory must be freed by calling EapHostPeerFreeRuntimeMemory.

ppwszIdentity [out]

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

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

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Eappapis.h

Library

Eappprxy.lib

DLL

Eapphost.dll

See also

EAPHost Supplicant Run-Time Functions
EapHostPeerGetUIContext

 

 

Community Additions

ADD
Show: