WDF_IO_QUEUE_STOPPED function (wdfio.h)
[Applies to KMDF and UMDF]
The WDF_IO_QUEUE_STOPPED function returns TRUE if an I/O queue's state indicates that the queue is stopped.
BOOLEAN WDF_IO_QUEUE_STOPPED(
[in] WDF_IO_QUEUE_STATE State
);
[in] State
A WDF_IO_QUEUE_STATE-typed value that WdfIoQueueGetState returns.
WDF_IO_QUEUE_STOPPED returns TRUE if the specified queue state indicates that the queue is stopped. Otherwise, the function returns FALSE.
An I/O queue is stopped if it can accept new I/O requests but the framework is not delivering them to the driver.
Your driver can call WDF_IO_QUEUE_STOPPED after it has called WdfIoQueueGetState.
For more information about I/O queue states, see WDF_IO_QUEUE_STATE.
The following code example is a routine that returns TRUE if a specified I/O queue is stopped.
BOOLEAN
IsQueueStopped(
IN WDFQUEUE Queue
)
{
WDF_IO_QUEUE_STATE queueStatus;
queueStatus = WdfIoQueueGetState(
Queue,
NULL,
NULL
);
return (WDF_IO_QUEUE_STOPPED(queueStatus)) ? TRUE : FALSE;
}
Requirement | Value |
---|---|
Target Platform | Universal |
Minimum KMDF version | 1.0 |
Header | wdfio.h (include Wdf.h) |
Library | None |
IRQL | Any IRQL. |