Share via

EapPeerInvokeIdentityUI (Compact 7)

  • Article

3/12/2014

This function raises a custom interactive user interface dialog to obtain user identity information for the EAP method on the client.

Syntax

DWORD WINAPI EapPeerInvokeIdentityUI(
  __in   EAP_METHOD_TYPE* pEapType,
  __in   DWORD dwflags,
  __in   HWND hwndParent,
  __in   DWORD dwSizeOfConnectionData,
  __in   const BYTE* pConnectionData,
  __out  DWORD dwSizeOfUserData,
  __in   const BYTE* pUserData,
  __out  DWORD* pdwSizeOfUserDataOut,
  __out  BYTE** ppUserDataOut,
  __out  LPWSTR* ppwszIdentity,
  __out  EAP_ERROR** ppEapError
);

Parameters

  • pEapType
    An EAP_METHOD_TYPE structure that contains vendor and author information about the EAP method that is used for authenticating the connection.
  • dwflags
    A combination of EAP Method Flags that describe the EAP authentication session behavior.
  • hwndParent
    A handle to the parent window which will spawn the interactive user interface dialog to obtain the identity data.
  • dwSizeOfConnectionData
    The size, in bytes, of the user interface context data specified by pUIContextData.
  • pConnectionData
    A pointer to an opaque byte buffer that contains the connection data.
  • dwSizeOfUserData
    Specifies the size, in bytes, of the user identity data returned in dwSizeOfUserData.
  • pUserData
    A pointer to the user data that is specific to this authentication that is used to pre-populate the user data. When this API is called for the first time, or when a new authentication session starts, this parameter is NULL. Otherwise, set this parameter to the pUserData member of the structure pointed to by the ppResult parameter received by EapPeerGetResult.
  • pdwSizeOfUserDataOut
    Specifies the size, in bytes, of the ppUserDataOut buffer.
  • ppUserDataOut
    A pointer to the pointer of the returned user data. The data is passed to EapPeerBeginSession as input pUserData.
  • ppwszIdentity
    A pointer to the returned user identity. The pointer will be included in the identity response packet and returned to the server.
  • ppEapError
    A pointer to the address of 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 EapPeerFreeErrorMemory.

Remarks

This call is performed by a peer-based EAPHost by using a function pointer to this API. This API must be implemented on the EAP method loaded by EAPHost, and must strictly comply with the syntax and parameter types that are specified in the documentation.

See Also

Reference

EAPHost Peer Method Configuration Functions
EapPeerInvokeIdentityUI