IPowerPolicyCallbackWakeFromSx::OnDisarmWakeFromSx 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 OnDisarmWakeFromSx event callback function disarms (that is, disables) a device's ability to trigger a wake signal while the device and system are in low-power states.

Syntax

void OnDisarmWakeFromSx(
  [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 OnDisarmWakeFromSx callback function if the driver supports the IPowerPolicyCallbackWakeFromSx interface.

If the driver has registered this callback function, the framework calls it after the framework has determined that system power is being restored, and after the bus driver completes the wait/wake IRP. Before calling the driver's OnDisarmWakeFromSx callback function, the framework calls the driver's IPnpCallback::OnD0Entry and IPowerPolicyCallbackWakeFromSx::OnWakeFromSxTriggered callback functions.

The OnDisarmWakeFromSx callback function must perform any hardware operations that are needed to disable the device's ability to trigger a wake signal after the power has been 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 System Wake-Up 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)