EapPeerGetResponseAttributes function (eapmethodpeerapis.h)

Article
10/13/2021

Obtains an array of EAP response attributes from the EAP method.

Syntax

DWORD EapPeerGetResponseAttributes(
  [in]  EAP_SESSION_HANDLE sessionHandle,
  [out] EapAttributes      *pAttribs,
  [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] pAttribs

A pointer to a EAP_ATTRIBUTES structure that contains an array of EAP authentication response attributes for the supplicant.

[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

EapPeerGetResponseAttributes is called by EAPHost when a prior call indicates that EAP response attributes are available.

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

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	eapmethodpeerapis.h