EapPeerEndSession function (eapmethodpeerapis.h)

Ends an EAP authentication session for the EAP method.

Syntax

DWORD EapPeerEndSession(
  [in]  EAP_SESSION_HANDLE sessionHandle,
  [out] EAP_ERROR          **ppEapError
);

Parameters

[in] 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.

[out] ppEapError

A pointer to a pointer to 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 calling EapPeerFreeErrorMemory.

Return value

None

Remarks

An authentication session involves a supplicant requesting authentication, and the EAP method that performs the authentication. When a supplicant closes an authentication session with a call to EapHostPeerEndSession, EAPHost must also close the session for the EAP method that performed the authentication with this API.

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

See also

EAPHost Peer Method Run-Time Functions

EapHostPeerClearConnection

EapPeerBeginSession