Edit

EapHostPeerClearConnection function (eappapis.h)

  • Article

Clears the authentication session connection. After EapHostPeerClearConnection is called, all states associated with pConnectionId are deleted, and no re-authentication associated with this GUID will be initiated. In addition, all future callbacks to the NotificationHandler callback function (which was passed by the calling supplicant in a previous call to EapHostPeerBeginSession) are halted.

Syntax

DWORD EapHostPeerClearConnection(
  [in]  GUID      *pConnectionId,
  [out] EAP_ERROR **ppEapError
);

Parameters

[in] pConnectionId

A pointer to a GUID value that uniquely identifies a logical network interface for a connection to terminate between the supplicant and the EAPHost. This connection ID must have been provided 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

EapHostPeerEndSession