Expand Minimize

EvtDeviceSelfManagedIoCleanup function

[Applies to KMDF and UMDF]

A driver's EvtDeviceSelfManagedIoCleanup event callback function handles deallocation activity for the device's self-managed I/O operations, after a device has been removed.

Syntax


EVT_WDF_DEVICE_SELF_MANAGED_IO_CLEANUP EvtDeviceSelfManagedIoCleanup;

VOID EvtDeviceSelfManagedIoCleanup(
  _In_  WDFDEVICE Device
)
{ ... }

Parameters

Device [in]

A handle to a framework device object.

Return value

None

Remarks

To register an EvtDeviceSelfManagedIoCleanup callback function, a driver must call WdfDeviceInitSetPnpPowerEventCallbacks.

If the driver has registered an EvtDeviceSelfManagedIoCleanup callback function, the framework calls it after the specified device has been removed from the system. For more information about when the framework calls this callback function, see PnP and Power Management Scenarios.

The framework calls the driver's EvtDeviceSelfManagedIoCleanup callback function after it has called the driver's EvtDeviceSelfManagedIoSuspend callback function. The EvtDeviceSelfManagedIoCleanup callback function must release any system resources that the driver allocated and associated with the device's self-managed I/O operations.

For more information about when the framework calls this callback function, see PnP and Power Management Scenarios.

For more information about drivers that provide this callback function, see Using Self-Managed I/O.

Examples

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


EVT_WDF_DEVICE_SELF_MANAGED_IO_CLEANUP  MyDeviceSelfManagedIoCleanup;

Then, implement your callback function as follows:


_Use_decl_annotations_
VOID
 MyDeviceSelfManagedIoCleanup (
    WDFDEVICE  Device
    )
  {...}

The EVT_WDF_DEVICE_SELF_MANAGED_IO_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_DEVICE_SELF_MANAGED_IO_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

EvtDeviceSelfManagedIoFlush
EvtDeviceSelfManagedIoInit
EvtDeviceSelfManagedIoRestart
EvtDeviceSelfManagedIoSuspend

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft