mirror of
https://github.com/fleschutz/PowerShell.git
synced 2024-11-15 20:44:17 +01:00
71 lines
1.6 KiB
Markdown
71 lines
1.6 KiB
Markdown
## The *edit.ps1* Script
|
|
|
|
This PowerShell script opens a text editor to edit the given file.
|
|
|
|
## Parameters
|
|
```powershell
|
|
edit.ps1 [[-Filename] <String>] [<CommonParameters>]
|
|
|
|
-Filename <String>
|
|
Specifies the path to the filename
|
|
|
|
Required? false
|
|
Position? 1
|
|
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> ./edit C:\MyFile.txt
|
|
|
|
```
|
|
|
|
## Notes
|
|
Author: Markus Fleschutz | License: CC0
|
|
|
|
## Related Links
|
|
https://github.com/fleschutz/PowerShell
|
|
|
|
## Source Code
|
|
```powershell
|
|
<#
|
|
.SYNOPSIS
|
|
Opens an editor to edit a file
|
|
.DESCRIPTION
|
|
This PowerShell script opens a text editor to edit the given file.
|
|
.PARAMETER Filename
|
|
Specifies the path to the filename
|
|
.EXAMPLE
|
|
PS> ./edit C:\MyFile.txt
|
|
.LINK
|
|
https://github.com/fleschutz/PowerShell
|
|
.NOTES
|
|
Author: Markus Fleschutz | License: CC0
|
|
#>
|
|
|
|
param([string]$Filename = "")
|
|
|
|
try {
|
|
if ($IsLinux) {
|
|
& vi "$Filename"
|
|
if ($lastExitCode -ne "0") { throw "Can't execute 'vi' - make sure vi is installed and available" }
|
|
} else {
|
|
& notepad.exe "$Filename"
|
|
if ($lastExitCode -ne "0") { throw "Can't execute 'notepad.exe' - make sure notepad.exe is installed and available" }
|
|
}
|
|
|
|
exit 0 # success
|
|
} catch {
|
|
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
|
exit 1
|
|
}
|
|
```
|
|
|
|
*Generated by convert-ps2md.ps1 using the comment-based help of edit.ps1*
|