PowerShell/Docs/display-time.md
2023-05-26 12:20:18 +02:00

71 lines
1.6 KiB
Markdown

## The *display-time.ps1* Script
This PowerShell script displays the current time (for 10 seconds by default)
## Parameters
```powershell
/home/mf/Repos/PowerShell/Scripts/display-time.ps1 [[-Seconds] <Int32>] [<CommonParameters>]
-Seconds <Int32>
Specifies the number of seconds to display the time
Required? false
Position? 1
Default value 10
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./display-time
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Source Code
```powershell
<#
.SYNOPSIS
Displays the current time
.DESCRIPTION
This PowerShell script displays the current time (for 10 seconds by default)
.PARAMETER Seconds
Specifies the number of seconds to display the time
.EXAMPLE
PS> ./display-time
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([int]$Seconds = 10)
try {
for ([int]$i = 0; $i -lt $Seconds; $i++) {
Clear-Host
Write-Output ""
$CurrentTime = Get-Date -format "yyyy-MM-dd HH:mm:ss"
./write-big $CurrentTime
Write-Output ""
Start-Sleep -seconds 1
}
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*Generated by convert-ps2md.ps1 using the comment-based help of display-time.ps1*