EapHostPeerGetUIContext function (eappapis.h)

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, and
• EapHostPeerSetUIContext

Syntax

DWORD EapHostPeerGetUIContext(
  [in]  EAP_SESSIONID sessionHandle,
  [out] DWORD         *pdwSizeOfUIContextData,
  [out] BYTE          **ppUIContextData,
  [out] EAP_ERROR     **ppEapError
);

Parameters

[in] 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.

[out] pdwSizeOfUIContextData

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

[out] 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.

[out] ppEapError

A pointer to the address of an EAP_ERROR structure. The address should be set to NULL before calling 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.

Return value

None

Requirements

See also

EAPHost Supplicant Run-time Functions

EapHostPeerInvokeInteractiveUI

EapHostPeerSetUIContext