NDIS_SET_PACKET_TIME_TO_SEND macro

Note NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.

This macro is obsolete for Microsoft Windows 2000 and later, and for Windows Me and later.

NDIS_SET_PACKET_TIME_TO_SEND sets the TimeToSend value in the out-of-band data block associated with a given packet descriptor.

Syntax

VOID NDIS_SET_PACKET_TIME_TO_SEND(
  [in] PNDIS_PACKET Packet,
  [in] ULONGLONG    TimeToSend
);

Parameters

Packet [in]
Pointer to a packet descriptor allocated by the caller for a send.
TimeToSend [in]
Specifies the system time at which the packet should be transmitted over the network.

Return value

None

Remarks

Protocols can use NDIS_SET_PACKET_TIME_TO_SEND to set this timestamp in the out-of-band data block associated with a driver-allocated packet descriptor to be passed in a subsequent call to NdisSendPackets or NdisSend. Setting the timestamp does not affect when the packet is actually transmitted; instead, the timestamp is used for recordkeeping. A protocol driver can use the timestamp to determined how long it takes to complete the sending of a paket.

All timestamps set in the NDIS_PACKET_OOB_DATA blocks associated with packet descriptors are expressed in system time units as the number of 100-nanosecond intervals since January 1, 1601.

A protocol can call NdisGetCurrentSystemTime and add some number of system time units to the returned value in order to supply the TimeToSend argument to NDIS_SET_PACKET_TIME_TO_SEND, unless the client that initiated the send request has already supplied such a timestamp.

Requirements

Target platform	Desktop
Header	Ndis.h (include Ndis.h)
IRQL	<= DISPATCH_LEVEL