IsPwrSuspendAllowed function (powrprof.h)

[IsPwrSuspendAllowed is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Applications written for Windows Vista and later should use GetPwrCapabilities instead.]

Determines whether the computer supports the sleep states.

Syntax

BOOLEAN IsPwrSuspendAllowed();

Return value

If the computer supports the sleep states (S1, S2, and S3), the function returns TRUE. Otherwise, the function returns FALSE.

Remarks

This information is also available through the CallNtPowerInformation function. Check the SystemS1, SystemS2, and SystemS3 members of the SYSTEM_POWER_CAPABILITIES structure.

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 powrprof.h
Library PowrProf.lib
DLL PowrProf.dll

See also

CallNtPowerInformation

Power Management Functions

SYSTEM_POWER_CAPABILITIES