PowerShell/docs/list-battery-status.md

68 lines
1.3 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*list-battery-status.ps1*
================
2022-12-04 10:40:18 +01:00
This PowerShell script lists the battery status.
2023-07-29 10:04:38 +02:00
Parameters
----------
2022-12-04 10:40:18 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./list-battery-status.ps1 [<CommonParameters>]
2022-12-04 10:40:18 +01:00
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Example
-------
2022-12-04 10:40:18 +01:00
```powershell
2023-08-06 21:36:33 +02:00
PS> ./list-battery-status.ps1
PowerLineStatus : Online
BatteryChargeStatus : NoSystemBattery
...
2022-12-04 10:40:18 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-12-04 10:40:18 +01:00
Author: Markus Fleschutz | License: CC0
2023-07-29 10:04:38 +02:00
Related Links
-------------
2022-12-04 10:40:18 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-12-04 10:40:18 +01:00
```powershell
<#
.SYNOPSIS
Lists the battery status
.DESCRIPTION
This PowerShell script lists the battery status.
.EXAMPLE
2023-08-06 21:36:33 +02:00
PS> ./list-battery-status.ps1
PowerLineStatus : Online
BatteryChargeStatus : NoSystemBattery
...
2022-12-04 10:40:18 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
try {
Add-Type -Assembly System.Windows.Forms
[System.Windows.Forms.SystemInformation]::PowerStatus
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
2023-12-16 10:12:58 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of list-battery-status.ps1 as of 12/16/2023 10:12:21)*