NDIS_SET_NET_BUFFER_LIST_CANCEL_ID macro (ndis.h)

Article
02/22/2024

The NDIS_SET_NET_BUFFER_LIST_CANCEL_ID macro marks a NET_BUFFER_LIST structure with a cancellation identifier that a driver can later use to cancel the pending transmission of the associated data.

Syntax

void NDIS_SET_NET_BUFFER_LIST_CANCEL_ID(
   _NBL,
   _CancelId
);

Parameters

_NBL

A pointer to a NET_BUFFER_LIST structure.

_CancelId

A ULONG value that is a cancellation identifier for the NET_BUFFER_LIST structure.

Return value

None

Remarks

An NDIS driver can call the NDIS_SET_NET_BUFFER_LIST_CANCEL_ID macro for each NET_BUFFER_LIST structure that it passes to lower-level drivers for transmission. The NDIS_SET_NET_BUFFER_LIST_CANCEL_ID macro marks the specified NET_BUFFER_LIST structure with a cancellation identifier. Drivers must call the NdisGeneratePartialCancelId function to obtain a value that the driver must use as the high-order byte of a cancellation identifier.

To cancel send requests, filter drivers call the NdisFCancelSendNetBufferLists function. Other drivers call the NdisCancelSendNetBufferLists function.

Drivers can call the NDIS_GET_NET_BUFFER_LIST_CANCEL_ID macro to retrieve a cancellation identifier from a NET_BUFFER_LIST structure.

Requirements

Requirement	Value
Minimum supported client	Supported in NDIS 6.0 and later.
Target Platform	Universal
Header	ndis.h