EapPeerSetUIContext function (eapmethodpeerapis.h)

Provides a user interface context to the EAP method. This function is called after the UI has been raised through the EapPeerGetUIContext function.

Syntax

DWORD EapPeerSetUIContext(
  [in]  EAP_SESSION_HANDLE  sessionHandle,
  [in]  DWORD               dwSizeOfUIContextData,
  [in]  const BYTE          *pUIContextData,
  [in]  EapPeerMethodOutput *pEapOutput,
  [out] EAP_ERROR           **ppEapError
);

Parameters

[in] sessionHandle

A pointer to an EAP_SESSION_HANDLE structure that contains the unique handle for this EAP authentication session on the EAPHost server. This handle is returned in the pSessionHandle parameter in a previous call to EapPeerBeginSession.

[in] dwSizeOfUIContextData

A pointer to a value that specifies the size of the UI context data byte buffer provided in pUIContextData.

[in] pUIContextData

A pointer to an address that contains a byte buffer with the new supplicant UI context data to set on EAPHost.

[in] pEapOutput

A pointer to an EapPeerMethodOutput structure that contains the output of the packet process operation.

[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 passing a pointer to 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 Run-Time Functions

EapPeerGetUIContext