PowerStatus (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Battery
Managing errors
Various

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

PowerStatus (Function)

In french: EtatAlimentation

Used to get various information about the main or secondary battery on the device where the application is run

Versions 23 and later

This function is now available in Android Widget mode.

This function is now available for the Android applications.

This function is now available for the iPhone/iPad applications (from version 230042).

New in version 23

This function is now available in Android Widget mode.

This function is now available for the Android applications.

This function is now available for the iPhone/iPad applications (from version 230042).

This function is now available in Android Widget mode.

This function is now available for the Android applications.

This function is now available for the iPhone/iPad applications (from version 230042).

Example

// Status of main battery?
Info("The battery is loaded at: " + PowerStatus(ChargePercentage) + " %")

Syntax

<Result> = PowerStatus(<Type of Information> [, <Battery>])

<Result>: Integer or boolean according to the type of information

Requested information,
Empty string ("") if the requested information is not available.

<Type of Information>: Integer constant

Specifies the type of requested information:
Charging
True if the battery is charging,
False otherwise.
ChargeLevel Charge level of battery:
0: battery not found.
1: high level.
2: low level.
3: critical level.
ChargePercentage Percentage of battery load.
ACLineStatus
True if the device is connected to the mains,
False otherwise.
RemainingLife Remaining lifetime (in seconds) of battery.
Versions 23 and later
This constant is not available.
New in version 23
This constant is not available.
This constant is not available.
TotalLife Total lifetime (in seconds) of battery.
Versions 23 and later
This constant is not available.
New in version 23
This constant is not available.
This constant is not available.

<Battery>: Optional boolean

True (by default) to get information about the main battery of device,
False to get information about the secondary battery of device.
Versions 23 and later
No information can be retrieved about the secondary battery. If <Battery> is set to False, <Result> will correspond to an empty string ("").
New in version 23
No information can be retrieved about the secondary battery. If <Battery> is set to False, <Result> will correspond to an empty string ("").
No information can be retrieved about the secondary battery. If <Battery> is set to False, <Result> will correspond to an empty string ("").

Remarks

Battery

Depending on the Mobile Device (Pocket PC) used, some information is not returned.
Some Mobile Devices are not equipped with batteries.
Versions 23 and later
No information can be retrieved about the secondary battery.
New in version 23
No information can be retrieved about the secondary battery.
No information can be retrieved about the secondary battery.
Versions 23 and later
The returned information is invalid in emulator mode.
New in version 23
The returned information is invalid in emulator mode.
The returned information is invalid in emulator mode.

Managing errors

Caution: PowerStatus returns no error code. To find out whether an error was generated by this function, use ErrorInfo associated with the errMessage constant.

Various

To find out the status of battery on the Mobile Device connected to the PC in a WINDEV application, use cePowerStatus.

Component : wp240ce.dll