Expand Minimize

EvtFileCleanup function

[Applies to KMDF and UMDF]

A driver's EvtFileCleanup callback function handles operations that must be performed when an application is closing all accesses to a device.

Syntax


EVT_WDF_FILE_CLEANUP EvtFileCleanup;

VOID EvtFileCleanup(
  _In_  WDFFILEOBJECT FileObject
)
{ ... }

Parameters

FileObject [in]

A handle to a framework file object, which was previously received by the driver's EvtDeviceFileCreate callback function.

Return value

None

Remarks

The framework calls a driver's EvtFileCleanup callback function when the last handle to the specified file object has been closed. (Because of outstanding I/O requests, this handle might not have been released.)

After the framework calls a driver's EvtFileCleanup callback function, it calls the driver's EvtFileClose callback function.

The EvtFileCleanup callback function is called synchronously, in the context of the thread that closed the last file object handle.

To register an EvtFileCleanup callback function, the driver must call the WdfDeviceInitSetFileObjectConfig method.

For more information about framework file objects and the EvtFileCleanup callback function, see Framework File Objects.

Examples

To define an EvtFileCleanup callback function, you must first provide a function declaration that identifies the type of callback function you’re defining. Windows provides a set of callback function types for drivers. Declaring a function using the callback function types helps Code Analysis for Drivers, Static Driver Verifier (SDV), and other verification tools find errors, and it’s a requirement for writing drivers for the Windows operating system.

For example, to define an EvtFileCleanup callback function that is named MyFileCleanup, use the EVT_WDF_FILE_CLEANUP type as shown in this code example:


EVT_WDF_FILE_CLEANUP  MyFileCleanup;

Then, implement your callback function as follows:


_Use_decl_annotations_
VOID
 MyFileCleanup (
    WDFFILEOBJECT  FileObject
    )
  {...}

The EVT_WDF_FILE_CLEANUP function type is defined in the Wdfdevice.h header file. To more accurately identify errors when you run the code analysis tools, be sure to add the _Use_decl_annotations_ annotation to your function definition. The _Use_decl_annotations_ annotation ensures that the annotations that are applied to the EVT_WDF_FILE_CLEANUP function type in the header file are used. For more information about the requirements for function declarations, see Declaring Functions by Using Function Role Types for KMDF Drivers. For information about _Use_decl_annotations_, see Annotating Function Behavior.

Requirements

Minimum KMDF version

1.0

Minimum UMDF version

2.0

Header

Wdfdevice.h (include Wdf.h)

IRQL

PASSIVE_LEVEL

See also

WDF_FILEOBJECT_CONFIG

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft