Share via

GetSystemPowerState (Compact 2013)

  • Article

3/26/2014

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 pBuffer in characters.

  • pFlags
    [out] Optional. Receives the system power state flags, which is the bitwise-OR of the POWER_STATE_XXX flags defined in the Pm.h header file. This parameter can be NULL.

    The following table shows the POWER_STATE_XXX flags.

    Flag

    Description

    POWER_STATE_BACKLIGHTON

    Screen backlight is on.

    POWER_STATE_BOOT

    Boot state

    POWER_STATE_CRITICAL

    Critical state

    POWER_STATE_IDLE

    Idle state

    POWER_STATE_OFF

    Off state

    POWER_STATE_ON

    On state

    POWER_STATE_PASSWORD

    Password protected power state.

    POWER_STATE_RESET

    Reset state

    POWER_STATE_SUSPEND

    Suspended state

    POWER_STATE_UNATTENDED

    Unattended state.

    POWER_STATE_USERIDLE

    User idle state.

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.

Requirements

Header

pm.h

Library

coredll.lib

See Also

Reference

Power Management Functions