WriteGlobalPwrPolicy function (powrprof.h)

[WriteGlobalPwrPolicy is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. See Remarks.]

Writes global power policy settings.

Syntax

BOOLEAN WriteGlobalPwrPolicy(
  [in] PGLOBAL_POWER_POLICY pGlobalPowerPolicy
);

Parameters

[in] pGlobalPowerPolicy

A pointer to a GLOBAL_POWER_POLICY structure that contains the power policy settings to be written.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The function replaces any existing global power policy settings. Each user has a separate global power scheme, which contains power policy settings that apply to all power schemes for that user.

Starting with Windows Vista, use the PowerEnumerate function to enumerate power settings for a specified scheme and the power write functions to write individual settings.

For more information on using PowrProf.h, see Power Schemes.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header powrprof.h
Library PowrProf.lib
DLL PowrProf.dll

See also

GLOBAL_POWER_POLICY

Power Management Functions

ReadGlobalPwrPolicy