EapHostPeerSetUIContext function (eappapis.h)

Provides a new or updated user interface context to the EAP peer method loaded on EAPHost after the UI has been raised. For more information about raising the UI, see EapHostPeerGetUIContext.

EapHostPeerSetUIContext sets the UI context data that was received from a call to EapHostPeerInvokeInteractiveUI.

Syntax

DWORD EapHostPeerSetUIContext(
  [in]  EAP_SESSIONID             sessionHandle,
  [in]  DWORD                     dwSizeOfUIContextData,
  [in]  const BYTE * const        pUIContextData,
  [out] EapHostPeerResponseAction *pEapOutput,
  [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.

[in] dwSizeOfUIContextData

The size, in bytes, of the user interface context data buffer provided in pUIContextData.

[in] pUIContextData

A pointer to a byte buffer that contains the new supplicant UI context data to be set on EAPHost. The data is returned from the EapHostPeerInvokeInteractiveUI OUT parameter.

[out] pEapOutput

A pointer to an EapHostPeerResponseAction enumeration value that specifies the action code for the next step the supplicant must take as a response.

[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

EapHostPeerGetUIContext

EapHostPeerInvokeInteractiveUI