Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 3.29 KB

nf-wudfddi-ifilecallbackcleanup-oncleanupfile.md

File metadata and controls

78 lines (56 loc) · 3.29 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.IFileCallbackCleanup.OnCleanupFile
IFileCallbackCleanup::OnCleanupFile (wudfddi.h)
The OnCleanupFile method cancels all I/O requests that a driver has pending in the framework queue.
wdf\ifilecallbackcleanup_oncleanupfile.htm
wdf
02/26/2018
IFileCallbackCleanup::OnCleanupFile
IFileCallbackCleanup interface,OnCleanupFile method, IFileCallbackCleanup.OnCleanupFile, IFileCallbackCleanup::OnCleanupFile, OnCleanupFile, OnCleanupFile method, OnCleanupFile method,IFileCallbackCleanup interface, UMDFFileObjectRef_a264918b-dd98-40e8-b644-d39414c2351c.xml, umdf.ifilecallbackcleanup_oncleanupfile, wdf.ifilecallbackcleanup_oncleanupfile, wudfddi/IFileCallbackCleanup::OnCleanupFile
wudfddi.h
Wudfddi.h
Windows
Windows
IFileCallbackCleanup::OnCleanupFile
wudfddi/IFileCallbackCleanup::OnCleanupFile
APIRef
kbSyntax
COM
Wudfddi.h
IFileCallbackCleanup::OnCleanupFile

IFileCallbackCleanup::OnCleanupFile

-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 OnCleanupFile method cancels all I/O requests that a driver has pending in the framework queue.

-parameters

-param pWdfFileObject [in]

A pointer to the IWDFFile interface for the file object that is associated with the device.

-remarks

A driver registers the IFileCallbackCleanup interface when the driver calls the IWDFDriver::CreateDevice method to create a device object.

The framework calls the OnCleanupFile method to notify the driver to cancel all I/O requests that it has pending. The framework notifies the driver in response to an application calling the Microsoft Win32 CloseHandle function.

For information about when the framework calls OnCleanupFile, see Driver-Created Versus Application-Created File Objects.

-see-also

IFileCallbackCleanup

IWDFDriver::CreateDevice

IWDFFile