PowerShell/Docs/remind-me.md

86 lines
2.5 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *remind-me.ps1* Script
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script creates a scheduled task that will display a popup message.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2023-05-26 12:20:18 +02:00
/home/mf/Repos/PowerShell/Scripts/remind-me.ps1 [[-Message] <String>] [[-Time] <DateTime>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-Message <String>
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Time <DateTime>
Required? false
Position? 2
Default value
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> ./remind-me "Dentist" "4/10/2021 12:00 PM"
TaskPath TaskName State
-------- -------- -----
\ Reminder_451733811 Ready
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2022-11-17 20:02:26 +01:00
## Source Code
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Creates a scheduled task that will display a popup message
.DESCRIPTION
This PowerShell script creates a scheduled task that will display a popup message.
.EXAMPLE
PS> ./remind-me "Dentist" "4/10/2021 12:00 PM"
TaskPath TaskName State
-------- -------- -----
\ Reminder_451733811 Ready
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
#requires -version 4
param([string]$Message = "", [datetime]$Time)
try {
if ($Message -eq "") { $Message = read-host "Enter reminder message" }
$Task = New-ScheduledTaskAction -Execute msg -Argument "* $Message"
$Trigger = New-ScheduledTaskTrigger -Once -At $Time
$Random = (Get-Random)
Register-ScheduledTask -Action $Task -Trigger $Trigger -TaskName "Reminder_$Random" -Description "Reminder"
exit 0
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2021-11-08 21:36:42 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of remind-me.ps1*