EapMethodAuthenticatorSendPacket function (eapmethodauthenticatorapis.h)

Obtains an authentication packet from the EAP authenticator method to send to the supplicant.

EapMethodAuthenticatorSendPacket is a function prototype.

Syntax

DWORD EapMethodAuthenticatorSendPacket(
  [in]      EAP_SESSION_HANDLE             sessionHandle,
  [in]      BYTE                           bPacketId,
  [in, out] DWORD                          *pcbSendPacket,
  [out]     EapPacket                      *pSendPacket,
  [out]     EAP_AUTHENTICATOR_SEND_TIMEOUT *pTimeout,
  [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] bPacketId

Specifies a numeric ID value for the packet to send.

[in, out] pcbSendPacket

Specifies the maximum size, in bytes, of the packet to send. On return, this parameter receives the size, in bytes, of the packet returned in pEapPacket.

[out] pSendPacket

A pointer to an EapPacket structure that contains the packet to send to the supplicant.

[out] pTimeout

A pointer to an EAP_AUTHENTICATOR_SEND_TIMEOUT enumeration that specifies the timeout for the packet.

[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

See also

EAPHost Authenticator Method Functions

EapMethodAuthenticatorBeginSession