Edit

KIPI_BROADCAST_WORKER callback function (wdm.h)

  • Article

The IpiGenericCall routine runs simultaneously on all processors.

Syntax

KIPI_BROADCAST_WORKER KipiBroadcastWorker;

ULONG_PTR KipiBroadcastWorker(
  [in] ULONG_PTR Argument
)
{...}

Parameters

[in] Argument

Supplies the value that was passed to the KeIpiGenericCall routine that called IpiGenericCall.

Return value

IpiGenericCall returns a driver-defined value. If IpiGenericCall ran on the same processor that called KeIpiGenericCall, KeIpiGenericCall returns the driver-defined value that IpiGenericCall returns. Otherwise, the value is ignored.

Remarks

IpiGenericCall routines run at IRQL = IPI_LEVEL, which is greater than DIRQL for every device. IpiGenericCall routines must satisfy the same restrictions as bug check callback routines. For more information about these restrictions, see Writing a Bug Check Callback Routine.

Examples

To define an IpiGenericCall 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 IpiGenericCall callback routine that is named MyIpiGenericCall, use the KIPI_BROADCAST_WORKER type as shown in this code example:

KIPI_BROADCAST_WORKER MyIpiGenericCall;

Then, implement your callback routine as follows:

_Use_decl_annotations_
ULONG_PTR
  MyIpiGenericCall(
    ULONG_PTR  Argument
    )
  {
      // Function body
  }

The KIPI_BROADCAST_WORKER 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 KIPI_BROADCAST_WORKER 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

Requirement Value
Target Platform Desktop
Header wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
IRQL Called at IPI_LEVEL.

See also

KeIpiGenericCall