ReadProcessorPwrScheme function (powrprof.h)

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

Retrieves the processor power policy settings for the specified power scheme.

Syntax

BOOLEAN ReadProcessorPwrScheme(
  [in]  UINT                            uiID,
  [out] PMACHINE_PROCESSOR_POWER_POLICY pMachineProcessorPowerPolicy
);

Parameters

[in] uiID

The index of the power scheme to be read.

[out] pMachineProcessorPowerPolicy

A pointer to a MACHINE_PROCESSOR_POWER_POLICY structure that receives the processor power policy settings.

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 MACHINE_PROCESSOR_POWER_POLICY structure contains processor power policy settings for use while the system is running on AC power or battery power.

Starting with Windows Vista, power management configuration of the system's processor is controlled through the GUID_PROCESSOR_SETTINGS_SUBGROUP power settings subgroup. Use the PowerEnumerate function to enumerate individual settings.

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

Requirements

See also

MACHINE_PROCESSOR_POWER_POLICY

Power Management Functions

Power Schemes

WriteProcessorPwrScheme