EapMethodAuthenticatorReceivePacket function (eapmethodauthenticatorapis.h)

Processes an EAP authentication packet received by the server EAPHost and returns a response action.

EapMethodAuthenticatorReceivePacket is a function prototype.

Syntax

DWORD EapMethodAuthenticatorReceivePacket(
  [in]  EAP_SESSION_HANDLE                       sessionHandle,
  [in]  DWORD                                    cbReceivePacket,
  [in]  const EapPacket * const                  pReceivePacket,
  [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] cbReceivePacket

The size, in bytes, of pReceivePacket.

[in] pReceivePacket

A pointer to an EapPacket structure that contains an EAP authentication session packet received from the supplicant by the server EAPHost.

[out] pEapOutput

A pointer to an EAP_METHOD_AUTHENTICATOR_RESPONSE_ACTION enumeration that indicates the next action the supplicant must take in the EAP authentication session.

[out] ppEapError

A pointer to the address of an EAP_ERROR structure that contains any errors raised by EAPHost 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

See also

EAPHost Authenticator Method Functions

EapMethodAuthenticatorBeginSession