Share via

EapPeerEndSession (Compact 2013)

  • Article

3/26/2014

Ends an EAP authentication session for the EAP method.

Syntax

DWORD WINAPI EapPeerEndSession(
  __in   EAP_SESSION_HANDLE sessionHandle,
  __out  EAP_ERROR** ppEapError
);

Parameters

  • 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.
  • ppEapError
    A pointer to a pointer to an EAP_ERROR structure that contains any errors raised during the execution of this function call. After using the error data, this memory must be freed by calling EapPeerFreeErrorMemory.

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 by using a function pointer to this API. This API must be implemented on the EAP method loaded by EAPHost, and must strictly comply with the syntax and parameter types that are specified in the documentation.

See Also

Reference

EAPHost Peer Method Run-Time Functions
EapPeerBeginSession
EapHostPeerClearConnection