EapPeerGetUIContext function (eapmethodpeerapis.h)

Obtains the user interface context from the EAP method. This function is always followed by the EapPeerInvokeInteractiveUI function, which is followed by the EapPeerSetUIContext function.

Syntax

DWORD EapPeerGetUIContext(
  [in]  EAP_SESSION_HANDLE sessionHandle,
  [out] DWORD              *pdwSizeOfUIContextData,
  [out] BYTE               **ppUIContextData,
  [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.

[out] pdwSizeOfUIContextData

A pointer to a value that specifies the size of the user interface context data byte buffer returned in ppUIContextData.

[out] ppUIContextData

A pointer to an address that contains a byte buffer with the supplicant user interface context data from EAPHost.

[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 the error data to EapPeerFreeErrorMemory.

Return value

None

Remarks

EapPeerGetUIContext is called by EAPHost when a prior call indicates that a user interface context is available.

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

EapPeerInvokeInteractiveUI

EapPeerSetUIContext