NDIS_GET_PACKET_CANCEL_ID (Compact 2013)

  • Article

3/26/2014

This macro returns the cancellation identifier assigned to a packet.

Syntax

PVOID NDIS_GET_PACKET_CANCEL_ID(
  PNDIS_PACKET _P
);

Parameters

  • _ P
    Points to an NDIS_PACKET structure that is the descriptor for a packet

Return Value

The return value is the cancellation identifier for the specified packet.

Remarks

A protocol or intermediate driver can call 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 identifier matches the cancellation identifier passed to the miniport driver's MiniportCancelSendPackets function, the miniport cancels the pending transmission of the packet.

The NDIS_GET_PACKET_CANCEL_ID macro is defined as follows.

#define NDIS_GET_PACKET_CANCEL_ID(_P) NDIS_PER_PACKET_INFO_FROM_PACKET(_P, PacketCancelId)

Requirements

Header

ndis.h

See Also

Reference

NDIS 5.x Legacy Network Driver Macros
NDIS_PACKET
NdisAllocatePacket
NdisAllocatePacketPool
NdisCancelSendPackets
NdisGeneratePartialCancelId
MiniportCancelSendPackets
NDIS_SET_PACKET_CANCEL_ID
NDIS 5.x Legacy Reference