PowerSettingAccessCheck function (powrprof.h)

Queries for a group policy override for specified power settings.

Syntax

DWORD PowerSettingAccessCheck(
  [in]           POWER_DATA_ACCESSOR AccessFlags,
  [in, optional] const GUID          *PowerGuid
);

Parameters

[in] AccessFlags

The type of access to check for group policy overrides.

Value Meaning
ACCESS_AC_POWER_SETTING_INDEX
0 (0x0)
Check for overrides on AC power settings.
ACCESS_DC_POWER_SETTING_INDEX
1 (0x1)
Check for overrides on DC power settings.
ACCESS_SCHEME
16 (0x10)
Check for restrictions on specific power schemes.
ACCESS_ACTIVE_SCHEME
19 (0x13)
Check for restrictions on active power schemes.
ACCESS_CREATE_SCHEME
20 (0x14)
Check for restrictions on creating or restoring power schemes.

[in, optional] PowerGuid

The identifier of the power setting.

Return value

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

Return code/value Description
ERROR_SUCCESS
0 (0x0)
The specified power setting is not currently overridden by a group policy.
ERROR_ACCESS_DISABLED_BY_POLICY
1260 (0x4EC)
This program is blocked by group policy. For more information, contact your system administrator.
ERROR_INSTALL_REMOTE_DISALLOWED
1640 (0x668)
Only Administrators can remotely access power settings.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header powrprof.h
Library PowrProf.lib
DLL PowrProf.dll

See also

POWER_DATA_ACCESSOR

Power Management Functions