Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

GetSystemPowerStatusEx (coredll)
 

coredll is for smart devices, not desktop Windows. Therefore, this information only applies to code using the .NET Compact Framework. To see if information for GetSystemPowerStatusEx in other DLLs exists, click on Find References to the right.

.
Summary
This will return the current status of the battery on a mobile device
Summary
Retrieves the power status of the system.

C# Signature:

[DllImport("coredll.dll", SetLastError = true)]
[return: MarshalAs(UnmanagedType.U4)]
public static extern int GetSystemPowerStatusEx2(SYSTEM_POWER_STATUS_EX2 pSystemPowerStatusEx2, [MarshalAs(UnmanagedType.U4), In] int dwLen, [MarshalAs(UnmanagedType.Bool), In] bool fUpdate);

VB Signature:

Declare Function GetSystemPowerStatusEx2 Lib "Coredll.dll" (TODO) As TODO
[DllImport("coredll.dll")]
static extern bool GetSystemPowerStatusEx(ref SYSTEM_POWER_STATUS_EX pStatus,
   bool fUpdate);

VB .NET Signature:

Declare Function GetSystemPowerStatusEx Lib "coredll.dll" _
   (<Out()> ByRef pStatus As SYSTEM_POWER_STATUS_EX, _
   ByVal fUpdate As Boolean) As Boolean

User-Defined Types:

SYSTEM_POWER_STATUS_EX2

SYSTEM_POWER_STATUS_EX

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

The return is the size of the structure. It returns 0 if there was an error.

Tips & Tricks:

Please add some!

pStatus must be a valid object as values will be passed back in this structure. As the pointer to the object is not changed do not use the ref/out keywords in C#.

Sample Code:

SYSTEM_POWER_STATUS_EX2 SystemPowerStatusEx2 = new SYSTEM_POWER_STATUS_EX2();
if (GetSystemPowerStatusEx2(SystemPowerStatusEx2, Marshal.SizeOf(SystemPowerStatusEx2), true) > 0) {
       //run some battery code
}

Tips & Tricks:

Please add some!

Documentation

Sample Code:

    public static byte GetBatteryLeftPercentage()
    {
        SYSTEM_POWER_STATUS_EX powerStatus = new SYSTEM_POWER_STATUS_EX();

        GetSystemPowerStatusEx( ref powerStatus, true);
        return powerStatus.BackupBatteryLifePercent;
    }

Complete VB.NET sample

    Private Declare Function GetSystemPowerStatusEx Lib "coredll.dll" (ByRef pStatus As SYSTEM_POWER_STATUS_EX, ByVal fUpdate As Boolean) As Boolean

    Private Structure SYSTEM_POWER_STATUS_EX
        Dim ACLineStatus As Byte
        Dim BatteryFlag As Byte
        Dim BatteryLifePercent As Byte
        Dim Reserved1 As Byte
        Dim BatteryLifeTime As Int32
        Dim BatteryFullLifeTime As Int32
        Dim Reserved2 As Byte
        Dim BatteryBackupFlag As Byte
        Dim BackupBatteryLifePercent As Byte
        Dim Reserved3 As Byte
        Dim BackupBatteryLifeTime As Int32
        Dim BackupBatteryFullLifeTime As Int32
    End Structure

    Public Function BatteryStrength() As Integer
        Dim battStatus As SYSTEM_POWER_STATUS_EX

        If GetSystemPowerStatusEx(battStatus, True) = True Then
            Return CInt(battStatus.BatteryLifePercent)
        Else
            Return 0
        End If
    End Function

Alternative Managed API:

TODO

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions