EVT_WDF_DEVICE_SELF_MANAGED_IO_FLUSH callback function

[Applies to KMDF and UMDF]

A driver's EvtDeviceSelfManagedIoFlush event callback function handles flush activity for the device's self-managed I/O operations.

Syntax

EVT_WDF_DEVICE_SELF_MANAGED_IO_FLUSH EvtWdfDeviceSelfManagedIoFlush;

void EvtWdfDeviceSelfManagedIoFlush(
  WDFDEVICE Device
)
{...}

Parameters

Device

A handle to a framework device object.

Return Value

None

Remarks

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

If the driver has registered an EvtDeviceSelfManagedIoFlush callback function, the framework calls it after the device has been removed. The driver should flush (that is, remove) I/O requests that are 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.

You must declare the function by using the EVT_WDF_DEVICE_SELF_MANAGED_IO_FLUSH type. For more information, see the following Example section.

Examples

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

EVT_WDF_DEVICE_SELF_MANAGED_IO_FLUSH  MyDeviceSelfManagedIoFlush;

Then, implement your callback function as follows:

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

The EVT_WDF_DEVICE_SELF_MANAGED_IO_FLUSH 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_FLUSH 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

   
Target Platform Universal
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header wdfdevice.h (include Wdf.h)
IRQL PASSIVE_LEVEL

See Also

EvtDeviceSelfManagedIoCleanup

EvtDeviceSelfManagedIoInit

EvtDeviceSelfManagedIoRestart

EvtDeviceSelfManagedIoSuspend