HW_CLEANUP_TRACING callback function (storport.h)

Article
02/22/2024

The HwStorCleanupTracing callback routine allows the Storport virtual miniport driver to stop tracing and to free any related resources.

Syntax

HW_CLEANUP_TRACING HwCleanupTracing;

void HwCleanupTracing(
  PVOID Arg1
)
{...}

Parameters

Arg1

A pointer to the driver object.

Return value

None

Remarks

The name HwStorCleanupTracing is placeholder text for the actual routine name. The actual prototype of this routine is defined in Storport.h as follows:

typedef
VOID
HW_CLEANUP_TRACING (
  IN PVOID  Arg1
  );

The port driver calls the Storport virtual miniport's HwStorCleanupTracing at PASSIVE_LEVEL.

Examples

To define an HwStorCleanupTracing 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 a HwStorCleanupTracing callback routine that is named MyHwCleanupTracing, use the HW_CLEANUP_TRACING type as shown in this code example:

HW_CLEANUP_TRACING MyHwCleanupTracing;

Then, implement your callback routine as follows:

_Use_decl_annotations_
VOID
MyHwCleanupTracing (
  _In_ PVOID  Arg1
  );
  {
      ...
  }

The HW_CLEANUP_TRACING function type is defined in the Storport.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 HW_CLEANUP_TRACING function type in the header file are used. For more information about the requirements for function declarations, see Declaring Functions Using Function Role Types for Storport Drivers. For information about Use_decl_annotations, see Annotating Function Behavior.

Requirements

Requirement	Value
Target Platform	Universal
Header	storport.h (include Storport.h)

Share via