NdisFCancelSendNetBufferLists function (ndis.h)

Article
04/18/2022

Filter drivers call the NdisFCancelSendNetBufferLists function to cancel the transmission of network data.

Syntax

void NdisFCancelSendNetBufferLists(
  [in] NDIS_HANDLE NdisFilterHandle,
  [in] PVOID       CancelId
);

Parameters

[in] NdisFilterHandle

The NDIS handle that identifies this filter module. NDIS passed the handle to the filter driver in a call to the FilterAttach function.

[in] CancelId

The cancellation identifier. This identifier specifies the network data for the transmission that is being canceled.

Return value

None

Remarks

A filter driver can cancel the send requests that it originates or pass on the cancellation requests from overlying drivers. To cancel a send request from an overlying driver, NDIS calls the filter drivers FilterCancelSendNetBufferLists function.

A filter driver can call the NDIS_SET_NET_BUFFER_LIST_CANCEL_ID macro to mark NET_BUFFER_LIST structures that it originates and passes down to lower-level drivers for transmission. The NDIS_SET_NET_BUFFER_LIST_CANCEL_ID macro marks the specified packet with a cancellation identifier.

NdisFCancelSendNetBufferLists cancels the transmission of all data that is marked with the specified cancellation identifier.

NDIS returns canceled send data that the filter driver originated to the FilterSendNetBufferListsComplete function. The completion status of canceled requests is NDIS_STATUS_SEND_ABORTED.

Requirements

Requirement	Value
Minimum supported client	Supported in NDIS 6.0 and later.
Target Platform	Desktop
Header	ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	<= DISPATCH_LEVEL
DDI compliance rules	Irql_Filter_Driver_Function(ndis)