WDF_IO_TARGET_PURGE_IO_ACTION - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// wdfiotarget.h

typedef enum _WDF_IO_TARGET_PURGE_IO_ACTION {
  WdfIoTargetPurgeIoUndefined = 0,
  WdfIoTargetPurgeIoAndWait = 1,
  WdfIoTargetPurgeIo = 2
} WDF_IO_TARGET_PURGE_IO_ACTION;
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (ne-wdfiotarget-_wdf_io_target_purge_io_action)

_WDF_IO_TARGET_PURGE_IO_ACTION enumeration

Description

[Applies to KMDF and UMDF]

The WDF_IO_TARGET_PURGE_IO_ACTION enumeration identifies the actions that the framework can take when a driver calls WdfIoTargetPurge to purge an I/O target.

Constants

WdfIoTargetPurgeIoUndefined:0

Reserved for system use.

WdfIoTargetPurgeIoAndWait:1

The framework attempts to cancel all of the I/O requests in the target's queue, and waits until all delivered requests are completed or canceled, before WdfIoTargetPurge returns. If the framework receives additional requests for the queue, it completes them with a completion status value of STATUS_INVALID_DEVICE_STATE.

WdfIoTargetPurgeIo:2

The framework attempts to cancel all of the target queue's I/O requests, before WdfIoTargetPurge returns.

Remarks

The WDF_IO_TARGET_PURGE_IO_ACTION enumeration is used as an input parameter to the WdfIoTargetPurge method.

If your driver specifies the WdfIoTargetPurgeIoAndWait flag, the driver must not call WdfIoTargetPurge from a request handler, a CompletionRoutine callback function, or an EvtUsbTargetPipeReadersFailed callback function.

See also

WDF_IO_TARGET_STATE

WdfIoTargetPurge