EapHostPeerGetIdentity function (eappapis.h)

• 12/05/2018
• 2 minutes to read

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 EapHostPeerGetIdentity(
  DWORD           dwVersion,
  DWORD           dwFlags,
  EAP_METHOD_TYPE eapMethodType,
  DWORD           dwSizeofConnectionData,
  const BYTE      *pConnectionData,
  DWORD           dwSizeofUserData,
  const BYTE      *pUserData,
  HANDLE          hTokenImpersonateUser,
  BOOL            *pfInvokeUI,
  DWORD           *pdwSizeOfUserDataOut,
  BYTE            **ppUserDataOut,
  LPWSTR          *ppwszIdentity,
  EAP_ERROR       **ppEapError,
  BYTE            **ppvReserved
);

Parameters

dwVersion

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

dwFlags

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

eapMethodType

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

dwSizeofConnectionData

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

pConnectionData

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

dwSizeofUserData

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

pUserData

Pointer to user credential information that pertains to this authentication session.

hTokenImpersonateUser

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

pfInvokeUI

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

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

ppUserDataOut

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

ppwszIdentity

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

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.

ppvReserved

Reserved for future use

Return value

None

Requirements

See also

EAPHost Supplicant Run-Time Functions

EapHostPeerGetUIContext