Expand Minimize

Win32_PortableBattery class

The Win32_PortableBattery WMI class contains the properties related to a portable battery, such as a notebook computer battery.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties and methods are in alphabetic order, not MOF order.

Syntax

[Provider("CIMWin32")]class Win32_PortableBattery : CIM_Battery
{
  uint16   Availability;
  uint32   BatteryRechargeTime;
  uint16   BatteryStatus;
  uint16   CapacityMultiplier;
  string   Caption;
  uint16   Chemistry;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  string   Description;
  uint32   DesignCapacity;
  uint64   DesignVoltage;
  string   DeviceID;
  boolean  ErrorCleared;
  string   ErrorDescription;
  uint16   EstimatedChargeRemaining;
  uint32   EstimatedRunTime;
  uint32   ExpectedBatteryLife;
  uint32   ExpectedLife;
  uint32   FullChargeCapacity;
  datetime InstallDate;
  uint32   LastErrorCode;
  string   Location;
  string   ManufactureDate;
  string   Manufacturer;
  uint16   MaxBatteryError;
  uint32   MaxRechargeTime;
  string   Name;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  string   SmartBatteryVersion;
  string   Status;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
  uint32   TimeOnBattery;
  uint32   TimeToFullCharge;
};

Members

The Win32_PortableBattery class has these types of members:

Methods

The Win32_PortableBattery class has these methods.

MethodDescription
Reset

Not implemented. To implement this method, see the Reset method in CIM_Battery.

SetPowerState

Not implemented. To implement this method, see the SetPowerState method in CIM_Battery.

 

Properties

The Win32_PortableBattery class has these properties.

Availability
Data type: uint16
Access type: Read-only

Availability and status of the device. Inherited from CIM_LogicalDevice.

ValueMeaning
1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

Running or Full Power

4 (0x4)

Warning

5 (0x5)

In Test

6 (0x6)

Not Applicable

7 (0x7)

Power Off

8 (0x8)

Off Line

9 (0x9)

Off Duty

10 (0xA)

Degraded

11 (0xB)

Not Installed

12 (0xC)

Install Error

13 (0xD)

Power Save - Unknown

The device is known to be in a power save mode, but its exact status is unknown.

14 (0xE)

Power Save - Low Power Mode

The device is in a power save state but still functioning, and may exhibit degraded performance.

15 (0xF)

Power Save - Standby

The device is not functioning, but could be brought to full power quickly.

16 (0x10)

Power Cycle

17 (0x11)

Power Save - Warning

The device is in a warning state, though also in a power save mode.

 

BatteryRechargeTime
Data type: uint32
Access type: Read-only

Time required to fully charge the battery. This property is inherited from CIM_Battery.

Windows Server 2003 and Windows XP:  This property is removed.

BatteryStatus
Data type: uint16
Access type: Read-only

Description of the battery's charge status. The value 10 (Undefined) is not valid in the Common Information Model (CIM) schema because in Desktop Management Interface (DMI) it indicates that no battery is installed. In this case, this object should not be instantiated. This property is inherited from CIM_Battery.

ValueMeaning
1

Other

2

Unknown

3

Fully Charged

4

Low

5

Critical

6

Charging

7

Charging and High

8

Charging and Low

9

Charging and Critical

10

Undefined

11

Partially Charged

 

CapacityMultiplier
Data type: uint16
Access type: Read-only

Multiplication factor of the DesignCapacity value to ensure that the milliwatt hour value does not overflow for Smart Battery Data Specification (SBDS) implementations.

Caption
Data type: string
Access type: Read-only

Short description of the object—a one-line string. This property is inherited from CIM_ManagedSystemElement.

Chemistry
Data type: uint16
Access type: Read-only

Chemistry of the battery. This property is inherited from CIM_Battery.

ValueMeaning
1

Other

2

Unknown

3

Lead Acid

4

Nickel Cadmium

5

Nickel Metal Hydride

6

Lithium-ion

7

Zinc air

8

Lithium Polymer

 

ConfigManagerErrorCode
Data type: uint32
Access type: Read-only

Win32 Configuration Manager error code.

ValueMeaning
0 (0x0)

Device is working properly.

1 (0x1)

Device is not configured correctly.

2 (0x2)

Windows cannot load the driver for this device.

3 (0x3)

Driver for this device might be corrupted, or the system may be low on memory or other resources.

4 (0x4)

Device is not working properly. One of its drivers or the registry might be corrupted.

5 (0x5)

Driver for the device requires a resource that Windows cannot manage.

6 (0x6)

Boot configuration for the device conflicts with other devices.

7 (0x7)

Cannot filter.

8 (0x8)

Driver loader for the device is missing.

9 (0x9)

Device is not working properly. The controlling firmware is incorrectly reporting the resources for the device.

10 (0xA)

Device cannot start.

11 (0xB)

Device failed.

12 (0xC)

Device cannot find enough free resources to use.

13 (0xD)

Windows cannot verify the device's resources.

14 (0xE)

Device cannot work properly until the computer is restarted.

15 (0xF)

Device is not working properly due to a possible re-enumeration problem.

16 (0x10)

Windows cannot identify all of the resources that the device uses.

17 (0x11)

Device is requesting an unknown resource type.

18 (0x12)

Device drivers must be reinstalled.

19 (0x13)

Failure using the VxD loader.

20 (0x14)

Registry might be corrupted.

21 (0x15)

System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device.

22 (0x16)

Device is disabled.

23 (0x17)

System failure. If changing the device driver is ineffective, see the hardware documentation.

24 (0x18)

Device is not present, not working properly, or does not have all of its drivers installed.

25 (0x19)

Windows is still setting up the device.

26 (0x1A)

Windows is still setting up the device.

27 (0x1B)

Device does not have valid log configuration.

28 (0x1C)

Device drivers are not installed.

29 (0x1D)

Device is disabled. The device firmware did not provide the required resources.

30 (0x1E)

Device is using an IRQ resource that another device is using.

31 (0x1F)

Device is not working properly. Windows cannot load the required device drivers.

 

ConfigManagerUserConfig
Data type: boolean
Access type: Read-only

If TRUE, the device is using a user-defined configuration. This property is inherited from CIM_LogicalDevice.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Name of the first concrete class that appears in the inheritance chain used in the creation of an instance. When used with the other key properties of the class, the property allows all instances of this class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.

Description
Data type: string
Access type: Read-only

Description of the object. This property is inherited from CIM_ManagedSystemElement.

DesignCapacity
Data type: uint32
Access type: Read-only

Design capacity of the battery in milliwatt-hours. If this property is not supported, enter 0 (zero). This property is inherited from CIM_Battery.

DesignVoltage
Data type: uint64
Access type: Read-only

Design voltage of the battery in millivolts. If this attribute is not supported, enter 0 (zero). This property is inherited from CIM_Battery.

For more information about using uint64 values in scripts, see Scripting in WMI.

DeviceID
Data type: string
Access type: Read-only

Battery identifier. This property is inherited from CIM_LogicalDevice.

Example: "Internal Battery"

ErrorCleared
Data type: boolean
Access type: Read-only

If TRUE, the error reported in LastErrorCode is now cleared. This property is inherited from CIM_LogicalDevice.

ErrorDescription
Data type: string
Access type: Read-only

More information about the error recorded in LastErrorCode, and any corrective actions that may be taken. This property is inherited from CIM_LogicalDevice.

EstimatedChargeRemaining
Data type: uint16
Access type: Read-only

Estimate of the percentage of full charge remaining. This property is inherited from CIM_Battery.

EstimatedRunTime
Data type: uint32
Access type: Read-only

Estimate in minutes of the time to battery charge depletion under the present load conditions if the utility power is off, or lost and remains off, or a laptop is disconnected from a power source. This property is inherited from CIM_Battery.

ExpectedBatteryLife
Data type: uint32
Access type: Read-only

Amount of time it takes to completely drain the battery after it has been fully charged. This property is inherited from CIM_Battery.

Windows Server 2003 and Windows XP:  This property has been removed.

ExpectedLife
Data type: uint32
Access type: Read-only

Battery's expected lifetime in minutes, assuming that the battery is fully charged. This property represents the total expected life of the battery, not its current remaining life, which is indicated by the EstimatedRunTime property. This property is inherited from CIM_Battery.

FullChargeCapacity
Data type: uint32
Access type: Read-only

Full charge capacity of the battery in milliwatt-hours. Comparison of this value to the DesignCapacity property determines when the battery requires replacement. A battery's end of life is typically when the FullChargeCapacity property falls below 80% of the DesignCapacity property. If this property is not supported, enter 0 (zero). This property is inherited from CIM_Battery.

InstallDate
Data type: datetime
Access type: Read-only

Date and time the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

LastErrorCode
Data type: uint32
Access type: Read-only

Last error code reported by the logical device. This property is inherited from CIM_LogicalDevice.

Location
Data type: string
Access type: Read-only

Physical location of the battery. This property is filled by the computer manufacturer.

Example: "In the back, on the left"

ManufactureDate
Data type: string
Access type: Read-only

Date when the battery was manufactured.

Manufacturer
Data type: string
Access type: Read-only

Manufacturer of the battery.

MaxBatteryError
Data type: uint16
Access type: Read-only
Qualifiers: Units (Percent)

Difference between the highest estimated amount of energy left in the battery and the current amount reported by the battery.

MaxRechargeTime
Data type: uint32
Access type: Read-only

Maximum time, in minutes, to fully charge the battery. This property represents the time to recharge a fully depleted battery, not the current remaining charge time, which is indicated in the TimeToFullCharge property. This property is inherited from CIM_Battery.

Name
Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, the property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

PNPDeviceID
Data type: string
Access type: Read-only

Windows Plug and Play device identifier of the logical device. This property is inherited from CIM_LogicalDevice.

Example: "*PNP030b"

PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only

Array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice.

ValueMeaning
0 (0x0)

Unknown

1 (0x1)

Not Supported

2 (0x2)

Disabled

3 (0x3)

Enabled

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

4 (0x4)

Power Saving Modes Entered Automatically

The device can change its power state based on usage or other criteria.

5 (0x5)

Power State Settable

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

6 (0x6)

Power Cycling Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).

7 (0x7)

Timed Power-On Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.

 

PowerManagementSupported
Data type: boolean
Access type: Read-only

If TRUE, the device can be power-managed (can be put into suspend mode, and so on). The property does not indicate that power management features are currently enabled, only that the logical device is capable of power management. This property is inherited from CIM_LogicalDevice.

SmartBatteryVersion
Data type: string
Access type: Read-only

Smart Battery Data Specification version number supported by this battery. If the battery does not support this function, the value should be left blank. This property is inherited from CIM_Battery.

Status
Data type: string
Access type: Read-only

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is online, yet the managed element is neither "OK" nor in one of the other states. This property is inherited from CIM_ManagedSystemElement.

The v7alues are:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
StatusInfo
Data type: uint16
Access type: Read-only

State of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used. This property is inherited from CIM_LogicalDevice.

ValueMeaning
1

Other

2

Unknown

3

Enabled

4

Disabled

5

Not Applicable

 

SystemCreationClassName
Data type: string
Access type: Read-only

Value of the scoping computer's CreationClassName property. This property is inherited from CIM_LogicalDevice.

SystemName
Data type: string
Access type: Read-only

Name of the scoping system. This property is inherited from CIM_LogicalDevice.

TimeOnBattery
Data type: uint32
Access type: Read-only

Elapsed time in seconds since the computer system's UPS last switched to battery power, or the time since the system or UPS was last restarted, whichever is less. If the battery is online, 0 (zero) is returned. This property is inherited from CIM_Battery.

TimeToFullCharge
Data type: uint32
Access type: Read-only

Remaining time in minutes to charge the battery fully at the current charge rate and usage. This property is inherited from CIM_Battery.

Remarks

The Win32_PortableBattery class is derived from CIM_Battery.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

See also

Computer System Hardware Classes

 

 

Show:
© 2014 Microsoft. All rights reserved.