EapHostPeerGetUIContext (Compact 2013)

3/26/2014

Obtains the user interface context for the supplicant from EAPHost if the UI is to be raised.

EAPHostPeerGetUIContext is always followed by the following functions.

• EapHostPeerInvokeInteractiveUI
  Raises an interactive user interface that is used to obtain credentials from the user.

• EapHostPeerSetUIContext
  Provides a new or updated user interface context to the EAP peer method loaded on EAPHost after the UI has been raised.

Syntax

DWORD APIENTRY EapHostPeerGetUIContext(
  __in   EAP_SESSIONID sessionHandle,
  __out  DWORD* pdwSizeOfUIContextData,
  __out  BYTE** ppUIContextData,
  __out  EAP_ERROR** ppEapError
);

Parameters

• sessionHandle
  A pointer to an EAP_SESSIONID structure that contains the unique handle for this EAP authentication session on the EAPHost server. This handle is returned in the pSessionId parameter in a previous call to EapHostPeerBeginSession.

• pdwSizeOfUIContextData
  A pointer to a value that specifies the size, in bytes, of the UI context data buffer returned in ppUIContextData.

• ppUIContextData
  A pointer to a pointer to a buffer that contains the supplicant UI context data from EAPHost. The address pointed to by this parameter is passed to EapHostPeerInvokeInteractiveUI as IN parameter pUIContextData.

• ppEapError
  A pointer to the address of an EAP_ERROR structure. The address should be set to NULL before the code calls this function. If error data is available, a pointer to the address of an EAP_ERROR structure that contains any errors raised during the execution of this function call is received. After using the error data, free this memory by calling EapHostPeerFreeEapError.

See Also

Reference

EAPHost Supplicant Run-time Functions
EapHostPeerInvokeInteractiveUI
EapHostPeerSetUIContext