Edit

WDF_IO_TARGET_PURGE_IO_ACTION enumeration (wdfiotarget.h)

  • Article

[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.

Syntax

typedef enum _WDF_IO_TARGET_PURGE_IO_ACTION {
  WdfIoTargetPurgeIoUndefined = 0,
  WdfIoTargetPurgeIoAndWait = 1,
  WdfIoTargetPurgeIo = 2
} WDF_IO_TARGET_PURGE_IO_ACTION;

Constants

 
WdfIoTargetPurgeIoUndefined
Value: 0
Reserved for system use.
WdfIoTargetPurgeIoAndWait
Value: 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
Value: 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.

Requirements

Requirement Value
Minimum KMDF version 1.11
Minimum UMDF version 2.0
Header wdfiotarget.h (include Wdf.h)

See also

WDF_IO_TARGET_STATE

WdfIoTargetPurge