IWDFIoQueue::PurgeSynchronously method (wudfddi.h)

[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 PurgeSynchronously method directs the framework to reject new incoming I/O requests and to cancel all outstanding requests. The method returns after all outstanding requests are canceled.

Syntax

void PurgeSynchronously();

Return value

None

Remarks

The framework cancels unprocessed requests in the queue. For requests that are delivered to the driver and marked cancelable, the framework calls IRequestCallbackCancel::OnCancel.

The PurgeSynchronously method is a synchronous version of the IWDFIoQueue::Purge method. That is, PurgeSynchronously does not return to the driver until all outstanding requests are canceled.

Requirements

Requirement	Value
End of support	Unavailable in UMDF 2.0 and later.
Target Platform	Desktop
Minimum UMDF version	1.5
Header	wudfddi.h (include Wudfddi.h)
DLL	WUDFx.dll

See also

IRequestCallbackCancel::OnCancel

IWDFIoQueue

IWDFIoQueue::Purge