Skip to content

Latest commit

 

History

History
69 lines (52 loc) · 3.05 KB

nf-wudfddi-iwdfioqueue-purgesynchronously.md

File metadata and controls

69 lines (52 loc) · 3.05 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:wudfddi.IWDFIoQueue.PurgeSynchronously
IWDFIoQueue::PurgeSynchronously (wudfddi.h)
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.
wdf\iwdfioqueue_purgesynchronously.htm
wdf
02/26/2018
IWDFIoQueue::PurgeSynchronously
IWDFIoQueue interface,PurgeSynchronously method, IWDFIoQueue.PurgeSynchronously, IWDFIoQueue::PurgeSynchronously, PurgeSynchronously, PurgeSynchronously method, PurgeSynchronously method,IWDFIoQueue interface, UMDFQueueObjectRef_c146c969-5b34-4aa0-af8e-9edec10f4c46.xml, umdf.iwdfioqueue_purgesynchronously, wdf.iwdfioqueue_purgesynchronously, wudfddi/IWDFIoQueue::PurgeSynchronously
wudfddi.h
Wudfddi.h
Desktop
1.5
Unavailable in UMDF 2.0 and later.
WUDFx.dll
Windows
IWDFIoQueue::PurgeSynchronously
wudfddi/IWDFIoQueue::PurgeSynchronously
APIRef
kbSyntax
COM
WUDFx.dll
IWDFIoQueue::PurgeSynchronously

IWDFIoQueue::PurgeSynchronously

-description

[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.

-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.

-see-also

IRequestCallbackCancel::OnCancel

IWDFIoQueue

IWDFIoQueue::Purge