EapHostPeerGetUIContext

EapHostPeerGetUIContext function

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.

Syntax


DWORD APIENTRY EapHostPeerGetUIContext(
  _In_  EAP_SESSIONID sessionHandle,
  _Out_ DWORD         *pdwSizeOfUIContextData,
  _Out_ BYTE          **ppUIContextData,
  _Out_ EAP_ERROR     **ppEapError
);

Parameters

sessionHandle [in]

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.

pdwSizeOfUIContextData [out]

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

ppUIContextData [out]

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.

ppEapError [out]

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.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Eappapis.h

Library

Eappprxy.lib

DLL

Eappprxy.dll

See also

EapHostPeerInvokeInteractiveUI
EapHostPeerSetUIContext
EAPHost Supplicant Run-time Functions

 

 

Community Additions

ADD
Show:
© 2016 Microsoft