EapPeerGetUIContext function

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 WINAPI EapPeerGetUIContext(
  _In_   EAP_SESSION_HANDLE sessionHandle,
  _Out_  DWORD *pdwSizeOfUIContextData,
  _Out_  BYTE **ppUIContextData,
  _Out_  EAP_ERROR **ppEapError
);

Parameters

sessionHandle [in]

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.

pdwSizeOfUIContextData [out]

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

ppUIContextData [out]

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

ppEapError [out]

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.

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Eapmethodpeerapis.h

See also

EapPeerInvokeInteractiveUI
EapPeerSetUIContext
EAPHost Peer Method Run-Time Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft