Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function returns the current system power state.

Syntax 

DWORD GetSystemPowerState(
  LPWSTR 
pBuffer,
  DWORD 
Length,
  PDWORD 
pFlags
);

Parameters

pBuffer

[out] Buffer to receive the system power state name.

Length

[in] Length of pBufferin characters.

pFlags

[out] Receives the system power state flags, which is the bitwise-OR of the POWER_STATE_ XXXflags defined in the Pm.h header file.

Return Value

ERROR_INSUFFICIENT_BUFFER

Indicates that the buffer is too small.

ERROR_NOT_FOUND

Indicates an unknown error.

ERROR_SUCCESS

Indicates success.

Win32 error code

Used for all other errors.

See Also

Concepts

Power States

Other Resources

Power Management Functions