EapHostPeerSetResponseAttributes function (eappapis.h)

Article
02/22/2024

Provides updated EAP authentication attributes to EAPHost.

Syntax

DWORD EapHostPeerSetResponseAttributes(
  [in]  EAP_SESSIONID               sessionHandle,
  [in]  const EapAttributes * const pAttribs,
  [out] EapHostPeerResponseAction   *pEapOutput,
  [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.

[in] pAttribs

A pointer to an EapAttributes structure that contains an array of new EAP authentication response attributes to set for the supplicant on EAPHost.

[out] pEapOutput

A pointer to an EapHostPeerResponseAction enumeration value that specifies the action code for the next step the supplicant must take as a response.

[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

Remarks

To progress to the next step in the state machine after a call to EapHostPeerGetResponseAttributes, the supplicant must call EapHostPeerSetResponseAttributes. The supplicant must do so to pass a valid EapAttributes structure, even if the supplicant cannot use the attributes returned from EapHostPeerGetResponseAttributes.

The following example shows a EapHostPeerSetResponseAttributes call that is made solely to progress to the next state in the state machine.

EapHostPeerGetResponseAttributes(session_id, &amp;eapAttributes, ppEapError);

// overwrite attributes returned by EapHostPeerGetResponseAttributes
EapAttributes eapAttributes={0,NULL};

// progress to the next state in the state machine
EapHostPeerSetResponseAttributes(session_id, &amp;eapAttributes, pEapOutput, ppEapError);

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	eappapis.h
Library	Eappprxy.lib
DLL	Eappprxy.dll