WdfIoQueueStopAndPurgeSynchronously function (wdfio.h)
[Applies to KMDF and UMDF]
The WdfIoQueueStopAndPurgeSynchronously method prevents an I/O queue from delivering new I/O requests and causes the framework to cancel existing unprocessed requests and driver-owned cancellable requests, but the queue receives and stores new requests.
Syntax
void WdfIoQueueStopAndPurgeSynchronously(
[in] WDFQUEUE Queue
);
Parameters
[in] Queue
A handle to a framework queue object.
Return value
None
Remarks
This method returns after all the unprocessed and driver-owned requests (not including requests added to the queue after this call is made) are completed or canceled. If new requests are inserted while WdfIoQueueStopAndPurgeSynchronously is in progress, these new requests are not delivered until driver calls WdfIoQueueStart.
A bug check occurs if the driver supplies an invalid object handle.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Universal |
| Minimum KMDF version | 1.11 |
| Minimum UMDF version | 2.0 |
| Header | wdfio.h (include Wdf.h) |
| Library | Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF) |
| IRQL | PASSIVE_LEVEL |
| DDI compliance rules | ChangeQueueState(kmdf), DriverCreate(kmdf), EvtSurpriseRemoveNoSuspendQueue(kmdf), NoCancelFromEvtSurpriseRemove(kmdf) |