EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS callback function

[Applies to KMDF only]

A bus driver's EvtDeviceDisableWakeAtBus event callback function performs bus-level operations that disable the ability of one of the bus's devices to trigger a wake-up signal on the bus.

Syntax

EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS EvtWdfDeviceDisableWakeAtBus;

void EvtWdfDeviceDisableWakeAtBus(
  WDFDEVICE Device
)
{...}

Parameters

Device

A handle to a framework device object.

Return Value

None

Remarks

For more information about this callback function, see Supporting System Wake-Up.

Examples

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

EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS  MyDeviceDisableWakeAtBus;

Then, implement your callback function as follows:

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

The EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS function type is defined in the Wdfpdo.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_DISABLE_WAKE_AT_BUS 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
Header wdfpdo.h (include Wdf.h)
IRQL PASSIVE_LEVEL

See Also

EvtDeviceEnableWakeAtBus