EapMethodAuthenticatorSetAttributes function (eapmethodauthenticatorapis.h)

Article
02/22/2024

Provides updated EAP authentication attributes to set on the EAP authenticator method.

EapMethodAuthenticatorSetAttributes is a function prototype.

Syntax

DWORD EapMethodAuthenticatorSetAttributes(
  [in]  EAP_SESSION_HANDLE                       sessionHandle,
  [in]  const EapAttributes * const              pAttribs,
  [out] EAP_METHOD_AUTHENTICATOR_RESPONSE_ACTION *pEapOutput,
  [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 EapMethodAuthenticatorBeginSession.

[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 EAP_METHOD_AUTHENTICATOR_RESPONSE_ACTION enumeration that specifies the suggested action the supplicant should take as a response to the updated attributes.

[out] ppEapError

A pointer to the address of 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 passing a pointer to the error data to EapMethodAuthenticatorFreeErrorMemory.

Return value

None

Remarks

This call is performed by a authenticator-based EAPHost using a function pointer to this API. This API must be implemented on the EAP authenticator 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	eapmethodauthenticatorapis.h