Hardware Dev Center

WDF_IO_TARGET_SENT_IO_ACTION (UMDF) enumeration

[Applies to UMDF 1.x only]

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          = 0,
  WdfIoTargetCancelSentIo             = 1,
  WdfIoTargetWaitForSentIoToComplete  = 2,
  WdfIoTargetLeaveSentIoPending       = 3,
  WdfIoTargetSentIoMaximum            = ( WdfIoTargetLeaveSentIoPending + 1 )
} WDF_IO_TARGET_SENT_IO_ACTION;

Constants

WdfIoTargetSentIoUndefined

Reservied 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

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.0

Header

Wudfddi.h (include Wudfddi.h)

See also

WDF_IO_TARGET_SENT_IO_ACTION

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft