Expand Minimize

EvtFileClose function

[Applies to KMDF and UMDF]

A driver's EvtFileClose callback function handles operations that must be performed when all of an application's accesses to a device have been closed.

Syntax


EVT_WDF_FILE_CLOSE EvtFileClose;

VOID EvtFileClose(
  _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 EvtFileClose callback function when the last handle for a file object has been closed and released, and all outstanding I/O requests have been completed or canceled.

The device might not be in its working (D0) state.

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

The EvtFileClose callback function is called synchronously, in an arbitrary thread context.

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

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

Examples

To define an EvtFileClose 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 EvtFileClose callback function that is named MyFileClose, use the EVT_WDF_FILE_CLOSE type as shown in this code example:


EVT_WDF_FILE_CLOSE MyFileClose;

Then, implement your callback function as follows:


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

The EVT_WDF_FILE_CLOSE 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_CLOSE 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