Export (0) Print
Expand All
Expand Minimize

ReadProcessorPwrScheme function

[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 WINAPI ReadProcessorPwrScheme(
  _In_   UINT uiID,
  _Out_  PMACHINE_PROCESSOR_POWER_POLICY pMachineProcessorPowerPolicy
);

Parameters

uiID [in]

The index of the power scheme to be read.

pMachineProcessorPowerPolicy [out]

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

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

PowrProf.h

Library

PowrProf.lib

DLL

PowrProf.dll

See also

Power Schemes
Power Management Functions
MACHINE_PROCESSOR_POWER_POLICY
WriteProcessorPwrScheme

 

 

Community Additions

ADD
Show:
© 2014 Microsoft