Edit

EapHostPeerEndSession function (eappapis.h)

  • Article

Terminates the current EAP authentication session between EAPHost and the calling supplicant, and clears data stored for the session.After this call the session is no longer valid.

Syntax

DWORD EapHostPeerEndSession(
  [in]  EAP_SESSIONID sessionHandle,
  [out] EAP_ERROR     **ppEapError
);

Parameters

[in] sessionHandle

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.

[out] ppEapError

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.

Return value

None

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header eappapis.h
Library Eappprxy.lib
DLL Eappprxy.dll

See also

EAPHost Supplicant Run-time Functions

EapHostPeerBeginSession

EapHostPeerClearConnection