EapHostPeerGetSendPacket function (eappapis.h)

Is called by the supplicant when the supplicant needs to obtains a packet from EAPHost to send to the authenticator. EapHostPeerGetSendPacket is called when the supplicant receives the EapHostPeerResponseAction enumerator from the server.

Syntax

DWORD EapHostPeerGetSendPacket(
  [in]  EAP_SESSIONID sessionHandle,
  [out] DWORD         *pcbSendPacket,
  [out] BYTE          **ppSendPacket,
  [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.

[out] pcbSendPacket

A pointer to a DWORD that specifies the maximum size, in bytes, of the buffer pointed to by ppSendPacket. EapHostPeerGetSendPacket on return is the size of the actual data pointed to by ppSendPacket.

[out] ppSendPacket

A pointer to a pointer to a buffer that contains the packet data returned by the EAP module. The buffer is allocated by EAPHost.

[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