Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 3.13 KB

nf-powersetting-powerregisterforeffectivepowermodenotifications.md

File metadata and controls

84 lines (65 loc) · 3.13 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:powersetting.PowerRegisterForEffectivePowerModeNotifications
PowerRegisterForEffectivePowerModeNotifications function (powersetting.h)
Registers a callback to receive effective power mode change notifications.
PowerRegisterForEffectivePowerModeNotifications
PowerRegisterForEffectivePowerModeNotifications function
base.powerregisterforeffectivepowermodenotifications
powersetting/PowerRegisterForEffectivePowerModeNotifications
base\powerregisterforeffectivepowermodenotifications.htm
base
3C87643F-A8DA-4230-A216-8F46629BB6FB
12/05/2018
PowerRegisterForEffectivePowerModeNotifications, PowerRegisterForEffectivePowerModeNotifications function, base.powerregisterforeffectivepowermodenotifications, powersetting/PowerRegisterForEffectivePowerModeNotifications
powersetting.h
Windows
Windows 10, version 1809 [desktop apps only]
None supported
Powrprof.lib
Powrprof.dll
Windows
RS5, 19H1
PowerRegisterForEffectivePowerModeNotifications
powersetting/PowerRegisterForEffectivePowerModeNotifications
c++
APIRef
kbSyntax
DllExport
Powrprof.dll
PowerRegisterForEffectivePowerModeNotifications

PowerRegisterForEffectivePowerModeNotifications function

-description

Registers a callback to receive effective power mode change notifications.

-parameters

-param Version

Supplies the maximum effective power mode version the caller understands. If the effective power mode comes from a later version, it is reduced to a compatible version that is then passed to the callback.

The following values can be passed in:

  • EFFECTIVE_POWER_MODE_V1 is available starting with Windows 10, version 1809 and tracks the performance power slider and battery saver states.
  • EFFECTIVE_POWER_MODE_V2 is available starting with Windows 10, version 1903 and tracks the performance power slider, battery saver, game mode and windows mixed reality power states.

-param Callback

A pointer to the callback to call when the effective power mode changes. This will also be called once upon registration to supply the current mode. If multiple callbacks are registered using this API, those callbacks can be called concurrently.

-param Context

Caller-specified opaque context.

-param RegistrationHandle

A handle to the registration. Use this handle to unregister for notifications.

-returns

Returns S_OK (zero) if the call was successful, and a nonzero value if the call failed.

-remarks

Immediately after registration, the callback will be invoked with the current value of the power setting. If the registration occurs while the power mode is changing, you may receive multiple callbacks; the last callback is the most recent update.