NDIS_GET_PACKET_CANCEL_ID function

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.

NDIS_GET_PACKET_CANCEL_ID returns the cancellation identifier assigned to a packet.

Syntax

PVOID NDIS_GET_PACKET_CANCEL_ID(
  _In_ PNDIS_PACKET Packet
);

Parameters

Packet [in]
Pointer to an NDIS_PACKET structure that is the descriptor for a packet.

Return value

Returns the cancellation identifier for the specified packet.

Remarks

A protocol or intermediate driver can calls NDIS_GET_PACKET_CANCEL_ID to obtain the cancellation identifier for a packet.

A miniport driver calls NDIS_GET_PACKET_CANCEL_ID from its MiniportCancelSendPackets function to obtain cancellation identifiers of packets in its send queue. If a packet's cancellation ID matches the cancellation ID passed to the miniport driver's MiniportCancelSendPackets function, the miniport driver cancels the pending transmission of the packet.

Requirements

Target platform	Desktop
Version	Available in Microsoft Windows XP and later versions of the Windows operating system.
Header	Ndis.h (include Ndis.h)
IRQL	<= DISPATCH_LEVEL