System.Machine.PowerStatus.isBatteryCharging Property
Gets the battery charging status.
This property is read-only.
Syntax
propVal = System.Machine.PowerStatus.isBatteryCharging()
Parameters
bIsCharging [out]
Retrieves whether or not the battery is charging.Value Meaning true The battery is charging.
false The battery is not charging.
Remarks
Returns false if the computer is plugged in but the battery is not attached.
Examples
The following example demonstrates how to get the power supply information for the computer.
// --------------------------------------------------------------------
// Get the machine power information.
// --------------------------------------------------------------------
function GetPowerStatus()
{
if (System.Machine.PowerStatus.isPowerLineConnected == false)
{
sMachinePowerInfo = "Power Supply: Battery<br/>";
sMachinePowerInfo += "Battery Capacity Remaining: " + System.Machine.batteryCapacityRemaining + "<br/>";
sMachinePowerInfo += "Battery Capacity Total: " + System.Machine.batteryCapacityTotal + "<br/>";
sMachinePowerInfo += "Battery Percent Remaining: " + System.Machine.batteryPercentRemaining + "<br/>";
sMachinePowerInfo += "Battery Status: " + System.Machine.batteryStatus + "<br/>";
sMachinePowerInfo += "Is Battery Charging: " + System.Machine.isBatteryCharging + "<br/>";
sMachinePowerInfo += "Available Memory: " + System.Machine.availableMemory + "<br/>";
}
else
{
sMachinePowerInfo += "Power Supply: Plugged in<br/>";
}
return sMachinePowerInfo;
}
Requirements
Minimum supported client | Windows Vista |
Minimum supported server | Windows Server 2008 |
IDL | Sidebar.idl |
DLL | Sidebar.Exe version 1.00 or later |
See Also
Send comments about this topic to Microsoft
Build date: 2/24/2010
Build type: SDK