IPowerPolicyCallbackWakeFromS0::OnDisarmWakeFromS0 method (wudfddi.h)

Article
02/22/2024

[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]

A driver's OnDisarmWakeFromS0 event callback function disarms (that is, disables) a device's ability to trigger a wake signal while in a low-power device state, if the system remains in the system working state (S0).

Syntax

void OnDisarmWakeFromS0(
  [in] IWDFDevice *pWdfDevice
);

Parameters

[in] pWdfDevice

A pointer to the IWDFDevice interface of the device object that represents one of the driver's devices.

Return value

None

Remarks

Your driver must provide an OnDisarmWakeFromS0 callback function if the driver supports the IPowerPolicyCallbackWakeFromS0 interface.

If the driver provides an OnDisarmWakeFromS0 callback function, the framework calls it after the bus driver determines that an event has awakened the device, and after the bus driver subsequently completes the wait/wake IRP. Before calling the driver's OnDisarmWakeFromS0 callback function, the framework calls the driver's IPnpCallback::OnD0Entry and IPowerPolicyCallbackWakeFromS0::OnWakeFromS0Triggered callback functions.

The OnDisarmWakeFromS0 callback function must perform any hardware operations that are needed to disable the device's ability to trigger a wake signal after the power is lowered.

For more information about when the framework calls this callback function, see PnP and Power Management Scenarios in UMDF.

For more information about this callback function, see Supporting Idle Power-Down in UMDF-based Drivers.

Requirements

Requirement	Value
End of support	Unavailable in UMDF 2.0 and later.
Target Platform	Desktop
Minimum UMDF version	1.9
Header	wudfddi.h (include Wudfddi.h)