EapPeerInvokeIdentityUI function (eapmethodpeerapis.h)

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

Syntax

DWORD 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

[in] pEapType

An EAP_METHOD_TYPE structure that contains vendor and author information about the EAP method used for authenticating the connection.

[in] dwFlags

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

[in] hwndParent

A handle to the parent window which will spawn the interactive user interface dialog to obtain the identity data.

[in] dwSizeOfConnectionData

The size, in bytes, of the user interface context data specified by pUIContextData.

[in] pConnectionData

A pointer to an opaque byte buffer that contains the connection data.

[out] dwSizeOfUserData

Specifies the size, in bytes, of the user identity data returned in dwSizeOfUserData.

[in] pUserData

A pointer to the user data specific to this authentication 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.

[out] pdwSizeOfUserDataOut

Specifies the size, in bytes, of the ppUserDataOut buffer.

[out] ppUserDataOut

A pointer to the pointer of the returned user data. The data is passed to EapPeerBeginSession as input pUserData.

[out] ppwszIdentity

A pointer to the returned user identity. The pointer will be included in the identity response packet and returned to the server.

[out] ppEapError

A pointer to the address of 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 EapPeerFreeErrorMemory.

Return value

None

Remarks

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

Requirements

See also

EAPHost Peer Method Configuration Functions

EapPeerInvokeIdentityUI