Share via

EapHostPeerSetResponseAttributes (Compact 2013)

  • Article

3/26/2014

Provides updated EAP authentication attributes to EAPHost.

Syntax

DWORD APIENTRY EapHostPeerSetResponseAttributes(
  __in   EAP_SESSIONID sessionHandle,
  __in   const EapAttributes* pAttribs,
  __out  EapHostPeerResponseAction* pEapOutput,
  __out  EAP_ERROR** ppEapError
);

Parameters

  • 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.
  • pAttribs
    A pointer to an EAP_ATTRIBUTES structure that contains an array of new EAP authentication response attributes to set for the supplicant on EAPHost.
  • pEapOutput
    A pointer to an EapHostPeerResponseAction enumeration value that specifies the action code for the next step the supplicant must take as a response.
  • ppEapError
    A pointer to the address of an EAP_ERROR structure. The address should be set to NULL before the code calls 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.

Remarks

To progress to the next step in the state computer 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 code shows a EapHostPeerSetResponseAttributes call that is made only to progress in the state computer.

EapHostPeerGetResponseAttributes(session_id, &eapAttributes, ppEapError);
// overwrite attributes returned by GetResponseAttributes
EapAttributes eapAttributes={0,NULL};
// progress to next state in state machine
EapHostPeerSetResponseAttributes(session_id, &eapAttributes, pEapOutput, ppEapError);

See Also

Reference

EAPHost Supplicant Run-time Functions
EapHostPeerGetResponseAttributes