WDF_IO_TARGET_PURGE_IO_ACTION enumeration

[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

Reserved for system use.

WdfIoTargetPurgeIoAndWait

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

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

Minimum KMDF version

1.11

Minimum UMDF version

2.0

Header

Wdfiotarget.h (include Wdf.h)

See also

WdfIoTargetPurge
WDF_IO_TARGET_STATE

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft