EapHostPeerFreeEapError (Compact 2013)

3/26/2014

Frees EAP_ERROR structures returned by EAPHost run-time APIs.

In contrast, the EapHostPeerFreeErrorMemory function is used only for freeing EAP_ERROR structures returned by EAPHost configuration APIs.

If any of the following run-time APIs are called and an EAP_ERROR is returned, EapHostPeerFreeEapError must be called to free the memory:

• EapHostPeerBeginSession
  Starts an EAP authentication session.

• EapHostPeerClearConnection
  Clears the authentication session connection.

• EapHostPeerEndSession
  Terminates the current EAP authentication session between EAPHost and the calling supplicant, and clears data that is stored for the session.

• EapHostPeerGetAuthStatus
  Obtains the supplicant's current EAP authentication status from EAPHost.

• EapHostPeerGetResponseAttributes
  Obtains an array of EAP authentication attributes from EAPHost.

• EapHostPeerGetResult
  Obtains the authentication result for the specified EAP authentication session.

• EapHostPeerGetSendPacket
  Is called by the supplicant when the supplicant needs to obtains a packet from EAPHost to send to the authenticator.

• EapHostPeerGetUIContext
  Obtains the user interface context for the supplicant from EAPHost if the UI is to be raised.

• EapHostPeerProcessReceivedPacket
  Is called by the supplicant every time that the supplicant receives a packet that EAPHost has to process.

• EapHostPeerSetResponseAttributes
  Provides updated EAP authentication attributes to EAPHost.

• EapHostPeerSetUIContext
  Provides a new or updated user interface context to the EAP peer method loaded on EAPHost after the UI has been raised.

Note

EAPHost run-time APIs are defined in eappapis.h. EAPHost configuration APIs are defined in EapHostPeerConfigApis.h.

Syntax

VOID APIENTRY EapHostPeerFreeEapError(
  __in  EAP_ERROR* ppEapError
);

Parameters

• ppEapError
  A pointer to an EAP_ERROR structure that contains the error data to free.

Return Value

This function does not return a value.

Remarks

To release all memory allocated by EAPHost for a authentication session, the caller must call EapHostPeerEndSession. To release all memory allocated by EAPHost for a connection, the caller must call the EapHostPeerClearConnection function.

EapHostPeerFreeEapError is not thread safe. Any given EAP_ERROR must be freed on one thread only. Do not call EapHostPeerFreeEapError twice on the same EAP_ERROR structure.

See Also

Reference

EAPHost Supplicant Run-time Functions
EapHostPeerFreeErrorMemory
EAPHost Supplicant Configuration Functions