Edit

Share via

WDF_IO_QUEUE_STATE enumeration (wdfio.h)

  • Article

[Applies to KMDF and UMDF]

The WDF_IO_QUEUE_STATE enumeration type identifies the status of a framework queue object. The enumerators are used as bit masks.

Syntax

typedef enum _WDF_IO_QUEUE_STATE {
  WdfIoQueueAcceptRequests = 0x01,
  WdfIoQueueDispatchRequests = 0x02,
  WdfIoQueueNoRequests = 0x04,
  WdfIoQueueDriverNoRequests = 0x08,
  WdfIoQueuePnpHeld = 0x10
} WDF_IO_QUEUE_STATE;

Constants

 
WdfIoQueueAcceptRequests
Value: 0x01
If set, the I/O queue can accept new I/O requests from the I/O manager and requests that are forwarded by the WdfDeviceConfigureRequestDispatching and WdfRequestForwardToIoQueue (or WdfRequestForwardToParentDeviceIoQueue) methods.

If not set, the framework cancels requests from the I/O manager and WdfDeviceConfigureRequestDispatching and fails requests from WdfRequestForwardToIoQueue (or WdfRequestForwardToParentDeviceIoQueue) with STATUS_WDF_BUSY.
WdfIoQueueDispatchRequests
Value: 0x02
If set, the framework delivers the queue's requests to the driver (unless the WdfIoQueuePnpHeld bit is also set). If not set, the driver cannot obtain requests from the queue.
WdfIoQueueNoRequests
Value: 0x04
If set, the I/O queue is empty.
WdfIoQueueDriverNoRequests
Value: 0x08
If set, all requests that have been delivered to the driver have been completed.
WdfIoQueuePnpHeld
Value: 0x10
If set, the framework has stopped delivering requests to the driver because the underlying device is not in its working (D0) state.

Remarks

The WDF_IO_QUEUE_STATE enumeration type is used as the return value for the WdfIoQueueGetState method.

The following functions are defined in wdfio.h:

Requirements

Requirement Value
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header wdfio.h (include Wdf.h)

See also

WdfIoQueueGetState