EapHostPeerFreeErrorMemory function (eaphostpeerconfigapis.h)

Frees memory allocated to an EAPHost supplicant configuration function 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
• EapHostPeerConfigXml2Blob
• EapHostPeerCredentialsXml2Blob
• EapHostPeerInvokeConfigUI
• EapHostPeerQueryCredentialsInputFields
• EapHostPeerQueryUserBlobFromCredentialsInputFields

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

 

Syntax

void EapHostPeerFreeErrorMemory(
  EAP_ERROR *pEapError
);

Parameters

pEapError

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

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	eaphostpeerconfigapis.h
Library	Eappcfg.lib
DLL	Eappcfg.dll

See also

EAPHost Supplicant Configuration Functions

EAPHost Supplicant Frequently Asked Questions

EapHostFreeEapError