Edit

EapHostPeerProcessReceivedPacket function (eappapis.h)

  • Article

Is called by the supplicant every time the supplicant receives a packet that EAPHost needs to process. EapHostPeerProcessReceivedPacket should be called only after a successful call to EapHostPeerBeginSession.

Syntax

DWORD EapHostPeerProcessReceivedPacket(
  [in]  EAP_SESSIONID             sessionHandle,
  [in]  DWORD                     cbReceivePacket,
  [in]  const BYTE * const        pReceivePacket,
  [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. sessionHandle can be zero if the supplicant receives a new identity request not associated with any session.

[in] cbReceivePacket

The size, in bytes, of the received packet buffer pointed to by the cbReceivePacket parameter.

[in] pReceivePacket

A pointer to a buffer that contains the incoming EAP data received by the supplicant.

[out] pEapOutput

A pointer to an EapHostPeerResponseAction value that indicates the supplicant should take appropriate action. Typically the supplicant either calls another method on EAPHost or acts on its own.

[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

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

See also

EAPHost Supplicant Run-time Functions