RtndStopTxQueue

RtndStopTxQueue stops the specified Transmit Queue.

Syntax

BOOL RtndStopTxQueue(
  [in]            ULONG_PTR RtndInterfaceId,
  [in]            ULONG TxQueueIndex,
  [in, ignored]   ULONG Flags
);

Parameters

[in] RtndInterfaceId

The number or pointer used to identify the interface. This value is returned by RtndManageInterface.

[in] RxQueueIndex

The index of the Transmit Queue.

[in, ignored] Flags

Reserved for future use. The value is set to zero by the NL2. Drivers must ignore this parameter.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. To get extended error information, call GetLastError.

Common error codes:

Note: Custom drivers may return other error codes not listed above.

Remarks

This function is expected to stop the hardware of the specified Physical Transmit Queue and move all the buffers that were in the submitted FIFO into the pool of available buffers.

If the stop operation takes time, it’s up to the driver to wait until the hardware is stopped before returning from this function.

The NL2 guarantees:

• It returns to the driver, with RtndReturnTxBuffers, all the Buffers of the queue that it owned before calling this function
• It doesn’t call any of RtndGetTxBuffers, RtndSubmitTxBuffer, RtndApplyTxBuffers, RtndExtractTxBuffer, RtndReturnTxBuffers, after calling this function and until the next call to RtndStartTxQueue.

Characteristics

Requirements

See Also:

• RtndManageInterface
• RtndStartTxQueue