Share via

EapHostPeerGetIdentity (Compact 2013)

  • Article

3/26/2014

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
    The version number of the API. Must be set to zero.
  • dwFlags
    A combination of EAP Method 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 applies 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 are not 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.
  • 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 using the error data, this memory must be freed by calling EapHostPeerFreeErrorMemory.
  • ppvReserved
    Reserved.

See Also

Reference

EAPHost Supplicant Run-time Functions
EapHostPeerGetUIContext