DRIVER_UNLOAD callback function (wdm.h)

The Unload routine performs any operations that are necessary before the system unloads the driver.

Syntax

DRIVER_UNLOAD DriverUnload;

void DriverUnload(
  [in] _DRIVER_OBJECT *DriverObject
)
{...}

Parameters

[in] DriverObject

Caller-supplied pointer to a DRIVER_OBJECT structure. This is the driver's driver object.

Return value

None

Remarks

A driver's Unload routine executes in a system thread context at IRQL = PASSIVE_LEVEL.

The Unload routine is required for WDM drivers and optional for non-WDM drivers. A driver's Unload routine, if supplied, should be named XxxUnload, where Xxx is a driver-specific prefix. The driver's DriverEntry routine must store the Unload routine's address in DriverObject->DriverUnload. (If no routine is supplied, this pointer must be NULL.)

For detailed information about implementing a driver's Unload routine, see Writing an Unload Routine.

Examples

To define an Unload callback routine, you must first provide a function declaration that identifies the type of callback routine 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 Unload callback routine that is named MyUnload, use the DRIVER_UNLOAD type as shown in this code example:

DRIVER_UNLOAD MyUnload;

Then, implement your callback routine as follows:

_Use_decl_annotations_
VOID 
  MyUnload(
    struct _DRIVER_OBJECT  *DriverObject
    )
  {
      // Function body
  }

The DRIVER_UNLOAD function type is defined in the Wdm.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 DRIVER_UNLOAD 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 WDM Drivers. For information about _Use_decl_annotations_, see Annotating Function Behavior.

Requirements