PowerShell/Docs/close-program.md

116 lines
3.2 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *close-program.ps1* Script
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script closes a program's processes gracefully.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2023-07-29 09:45:37 +02:00
close-program.ps1 [[-FullProgramName] <String>] [[-ProgramName] <String>] [[-ProgramAliasName] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-FullProgramName <String>
Specifies the full program name
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProgramName <String>
Specifies the program name
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProgramAliasName <String>
Specifies the program alias name
Required? false
Position? 3
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> ./close-program "Google Chrome" "chrome.exe"
```
## 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
Closes a program's processes
.DESCRIPTION
This PowerShell script closes a program's processes gracefully.
.PARAMETER FullProgramName
Specifies the full program name
.PARAMETER ProgramName
Specifies the program name
.PARAMETER ProgramAliasName
Specifies the program alias name
.EXAMPLE
PS> ./close-program "Google Chrome" "chrome.exe"
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$FullProgramName = "", [string]$ProgramName = "", [string]$ProgramAliasName = "")
try {
if ($ProgramName -eq "") {
get-process | where-object {$_.mainWindowTitle} | format-table Id, Name, mainWindowtitle -AutoSize
$ProgramName = read-host "Enter program name"
}
if ($FullProgramName -eq "") {
$FullProgramName = $ProgramName
}
$Processes = get-process -name $ProgramName -errorAction 'silentlycontinue'
if ($Processes.Count -ne 0) {
foreach ($Process in $Processes) {
$Process.CloseMainWindow() | Out-Null
}
2023-05-26 12:20:18 +02:00
Start-Sleep -milliseconds 100
2022-11-17 20:02:26 +01:00
stop-process -name $ProgramName -force -errorAction 'silentlycontinue'
} else {
$Processes = get-process -name $ProgramAliasName -errorAction 'silentlycontinue'
if ($Processes.Count -eq 0) {
throw "$FullProgramName isn't running"
}
foreach ($Process in $Processes) {
$_.CloseMainWindow() | Out-Null
}
2023-05-26 12:20:18 +02:00
Start-Sleep -milliseconds 100
2022-11-17 20:02:26 +01:00
stop-process -name $ProgramName -force -errorAction 'silentlycontinue'
}
if ($($Processes.Count) -eq 1) {
"✔️ $FullProgramName closed, 1 process stopped"
} else {
"✔️ $FullProgramName closed, $($Processes.Count) processes stopped"
}
exit 0 # success
} 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 close-program.ps1*