NdisMSendNetBufferListsComplete (Compact 2013)

3/26/2014

Miniport drivers call this function to return a linked list of NET_BUFFER_LIST structures to an overlying driver and to return the final status of a send request.

Syntax

VOID
  NdisMSendNetBufferListsComplete(
    IN NDIS_HANDLE  MiniportAdapterHandle,
    IN PNET_BUFFER_LIST  NetBufferLists,
    IN ULONG  SendCompleteFlags
    );

Parameters

• MiniportAdapterHandle
  The miniport handle that NDIS passed to the MiniportInitializeEx function.

• NetBufferLists
  A pointer to a linked list of NET_BUFFER_LIST structures. The miniport driver received the NET_BUFFER_LIST structures in previous calls to its MiniportSendNetBufferLists function.

• SendCompleteFlags
  NDIS flags that can be combined with an OR operation. To clear all the flags, set this member to zero. This function supports the NDIS_SEND_COMPLETE_FLAGS_DISPATCH_LEVEL flag which; if set, indicates that the current IRQL is DISPATCH_LEVEL.

Return Value

None

Remarks

A miniport driver calls NdisMSendNetBufferListsComplete to complete send requests that NDIS made to the driver's MiniportSendNetBufferLists function. The miniport driver specifies a linked list of NET_BUFFER_LIST structures that are associated with the completed send requests. While the status of the send requests is pending, the miniport driver retains ownership of the NET_BUFFER_LIST structures and all the protocol-allocated resources that are associated with the NET_BUFFER_LIST structures.

After a miniport driver calls NdisMSendNetBufferListsComplete, NDIS calls the ProtocolSendNetBufferListsComplete function of the driver that called the NdisSendNetBufferLists function to initiate the send request.

The miniport driver can complete send requests in any order. For example, the miniport driver could concatenate the NET_BUFFER_LIST structure lists from multiple MiniportSendNetBufferLists calls or split up a list from a MiniportSendNetBufferLists call. However, the miniport driver must not modify the list of NET_BUFFER structures that are associated with a NET_BUFFER_LIST structure.

The miniport driver must set one of the following status codes in the Status member of each NET_BUFFER_LIST structure that the NetBufferLists parameter specifies:

• NDIS_STATUS_SUCCESS
  All the network data described by NET_BUFFER structures associated with this NET_BUFFER_LIST structure was successfully transmitted over the network.

• NDIS_STATUS_INVALID_NET_BUFFER
  The size of the data in some NET_BUFFER structures associated with this NET_BUFFER_LIST structure was too large for the underlying network adapter.

• NDIS_STATUS_RESOURCES
  The send request for this NET_BUFFER_LIST structure failed because of insufficient resources.

• NDIS_STATUS_FAILURE
  A failure occurred

• NDIS_STATUS_PAUSED
  The miniport adapter is in the Paused state, as described on the reference page for the MiniportPause function.

• NDIS_STATUS_SEND_ABORTED
  NDIS called the MiniportCancelSend function to cancel the send operation for this NET_BUFFER_LIST structure.

• NDIS_STATUS_RESET_IN_PROGRESS
  The miniport driver aborted the send request because of a reset.

A miniport driver's call to NdisMSendNetBufferListsComplete does not necessarily mean that the data for a send request has been transmitted over the network. The data might be queued in the network adapter hardware.

Requirements

Header

ndis.h

See Also

Reference

NDIS Send and Receive Functions for Miniport Drivers
MiniportInitializeEx
NdisSendNetBufferLists
NET_BUFFER
NET_BUFFER_LIST