Edit

Share via


GetPwrCapabilities function (powerbase.h)

Retrieves information about the system power capabilities.

Syntax

BOOLEAN GetPwrCapabilities(
  [out] PSYSTEM_POWER_CAPABILITIES lpspc
);

Parameters

[out] lpspc

A pointer to a SYSTEM_POWER_CAPABILITIES structure that receives the information.

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

This function retrieves detailed information about the current system power management hardware resources and capabilities. This includes information about the presence of hardware features such as power buttons, lid switches, and batteries. Other details returned include information about current power management capabilities and configurations that can change dynamically, such as the minimum sleep state currently supported, which may change as new drivers are introduced into the system, or the presence of the system hibernation file.

This information is also available through the CallNtPowerInformation function, using the SystemPowerCapabilities level.

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

Requirements

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

See also

CallNtPowerInformation

Power Management Functions

SYSTEM_POWER_CAPABILITIES