NdisSetPacketCancelId 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.

NdisSetPacketCancelId marks a packet with a cancellation identifier that a driver can later use to cancel the pending transmission of the packet.

Syntax

VOID NdisSetPacketCancelId(
  _In_ PNDIS_PACKET Packet,
  _In_ PVOID        CancelId
);

Parameters

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

  • CancelId [in]
    Specifies a cancellation identifier.

Return value

None

Remarks

The NdisSetPacketCancelId and NDIS_SET_PACKET_CANCEL_ID macros can be used interchangeably. For more information about NdisSetPacketCancelId, see NDIS_SET_PACKET_CANCEL_ID.

System support for NdisSetPacketCancelId is available in Windows XP and later versions.

Requirements

Target platform

Universal

Version

Not supported for NDIS 6.0 drivers in Windows Vista. Use NDIS_SET_NET_BUFFER_LIST_CANCEL_IDinstead. Supported for NDIS 5.1 drivers in Windows Vista and Windows XP.

Header

Ndis.h (include Ndis.h)

Library

Ndis.lib

IRQL

<= DISPATCH_LEVEL

See also

MiniportCancelSendPackets

NdisCancelSendPackets

NdisGeneratePartialCancelId

NDIS_GET_PACKET_CANCEL_ID

NdisGetPacketCancelId

NDIS_PACKET

NDIS_SET_PACKET_CANCEL_ID

 

 

Send comments about this topic to Microsoft