EapHostPeerGetResponseAttributes function (eappapis.h)

Obtains an array of EAP authentication attributes from EAPHost. After calling EapHostPeerGetResponseAttributes and finishing the processing of EAP attributes, the supplicant should call EapHostPeerSetResponseAttributes.

Syntax

DWORD EapHostPeerGetResponseAttributes(
  [in]  EAP_SESSIONID sessionHandle,
  [out] EapAttributes *pAttribs,
  [out] EAP_ERROR     **ppEapError
);

Parameters

[in] sessionHandle

A pointer to an EAP_SESSIONID structure that contains the unique handle for this EAP authentication session on the EAPHost server. This handle is returned in the pSessionId parameter in a previous call to EapHostPeerBeginSession.

[out] pAttribs

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

[out] ppEapError

A pointer to the address of an EAP_ERROR structure. The address should be set to NULL before calling this function. If error data is available, a pointer to the address of an EAP_ERROR structure that contains any errors raised during the execution of this function call is received. After using the error data, free this memory by calling EapHostPeerFreeEapError.

Return value

None

Requirements

See also

EAPHost Supplicant Run-time Functions

EapHostPeerSetResponseAttributes