Edit

WDF_IO_TARGET_SENT_IO_ACTION enumeration (wudfddi_types.h)

  • Article

[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]

The WDF_IO_TARGET_SENT_IO_ACTION enumeration identifies the actions that the framework can take when a driver calls IWDFIoTargetStateManagement::Stop or IWDFRemoteTarget::Stop to stop an I/O target.

Syntax

typedef enum _WDF_IO_TARGET_SENT_IO_ACTION {
  WdfIoTargetSentIoUndefined,
  WdfIoTargetCancelSentIo,
  WdfIoTargetWaitForSentIoToComplete,
  WdfIoTargetLeaveSentIoPending,
  WdfIoTargetSentIoMaximum
} WDF_IO_TARGET_SENT_IO_ACTION;

Constants

 
WdfIoTargetSentIoUndefined
Reserved for system use.
WdfIoTargetCancelSentIo
Before the framework stops the I/O target, it will attempt to cancel I/O requests that are in the I/O target's queue. The framework cancels all of the target queue's I/O requests before IWDFIoTargetStateManagement::Stop or IWDFRemoteTarget::Stop returns.
WdfIoTargetWaitForSentIoToComplete
Before the framework stops the I/O target, it will wait for I/O requests that are in the I/O target's queue to be completed. The framework completes all of the target queue's I/O requests, and calls each request's IRequestCallbackRequestCompletion::OnCompletion callback function, before IWDFIoTargetStateManagement::Stop or IWDFRemoteTarget::Stop returns.
WdfIoTargetLeaveSentIoPending
The framework will leave I/O requests in the I/O target's queue. The requests remain in the target's queue until the driver calls IWDFIoTargetStateManagement::Start or IWDFRemoteTarget::Start or the device is removed.
WdfIoTargetSentIoMaximum
Valid enumeration values were exceeded.

Remarks

The WDF_IO_TARGET_SENT_IO_ACTION enumeration is used as an input parameter to the IWDFIoTargetStateManagement::Stop and IWDFRemoteTarget::Stop methods.

If your driver specifies the WdfIoTargetWaitForSentIoToComplete flag, the driver must not call IWDFIoTargetStateManagement::Stop or IWDFRemoteTarget::Stop from a request handler, an IRequestCallbackRequestCompletion::OnCompletion callback function, or an IUsbTargetPipeContinuousReaderCallbackReadersFailed::OnReaderFailure callback function.

For the KMDF version of this enumeration, see WDF_IO_TARGET_SENT_IO_ACTION.

Requirements

Requirement Value
Minimum UMDF version 1.0
Header wudfddi_types.h (include Wudfddi.h)

See also

WDF_IO_TARGET_SENT_IO_ACTION