EapHostPeerFreeErrorMemory (Compact 2013)

3/26/2014

Frees memory allocated to an EAP_ERROR structure. An EAP ERROR structure is created whenever an EAPHost Supplicant Configuration Functions fails.

The EapHostPeerFreeErrorMemory function is used only for freeing EAP_ERROR structures returned by EAPHost configuration APIs, while the EapHostPeerFreeEapError function is used for freeing EAP_ERROR structures returned by EAPHost run-time APIs.

If any of the following configuration APIs functions are called, and an EAP_ERROR is returned, EapHostPeerFreeErrorMemory must be called to free the memory:

• EapHostPeerConfigBlob2Xml
  Converts the configuration BLOB to XML.

• EapHostPeerConfigXml2Blob
  Converts XML into the configuration BLOB.

• EapHostPeerCredentialsXml2Blob
  Generates the credentials BLOB.

• EapHostPeerInvokeConfigUI
  Starts the configuration user interface of the specified EAP method.

• EapHostPeerQueryCredentialInputFields
  Allows the user to determine what kind of credentials are required by the methods to perform authentication.

• EapHostPeerQueryUserBlobFromCredentialInputFields
  Obtains a credential BLOB.

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

Syntax

VOID WINAPI EapHostPeerFreeErrorMemory(
    EAP_ERROR* pEapError
);

Parameters

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

Return Value

This function does not return a value.

See Also

Reference

EAPHost Supplicant Configuration Functions
EapHostPeerFreeEapError