Share via


EapPeerSetUIContext (Compact 2013)

3/26/2014

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 WINAPI EapPeerSetUIContext(
  __in   EAP_SESSION_HANDLE sessionHandle,
  __in   DWORD dwSizeOfUIContextData,
  __in   const BYTE* pUIContextData,
  __in   EapPeerMethodOutput* pEapOutput,
  __out  EAP_ERROR** ppEapError
);

Parameters

  • 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.
  • dwSizeOfUIContextData
    A pointer to a value that specifies the size of the UI context data byte buffer provided in pUIContextData.
  • pUIContextData
    A pointer to an address that contains a byte buffer with the new supplicant UI context data to set on EAPHost.
  • pEapOutput
    A pointer to an EapPeerMethodOutput structure that contains the output of the packet process operation.
  • ppEapError
    A pointer to the address of an EAP_ERROR structure that contains any errors raised during the execution of this function call. After using the error data, this memory must be freed by passing a pointer to EapPeerFreeErrorMemory.

Remarks

This call is performed by a peer-based EAPHost by using a function pointer to this API. This API must be implemented on the EAP method loaded by EAPHost, and must strictly comply with the syntax and parameter types that are specified in the documentation.

See Also

Reference

EAPHost Peer Method Run-Time Functions
EapPeerGetUIContext