PowerShell/Docs/open-documents-folder.md

55 lines
1.3 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *open-documents-folder.ps1* Script
2021-12-09 16:19:09 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script launches the File Explorer with the user's documents folder.
2021-12-09 16:19:09 +01:00
## Parameters
```powershell
2023-05-26 12:20:18 +02:00
/home/mf/Repos/PowerShell/Scripts/open-documents-folder.ps1 [<CommonParameters>]
2021-12-09 16:19:09 +01:00
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./open-documents-folder
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-12-09 16:19:09 +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
Opens the documents folder
.DESCRIPTION
This PowerShell script launches the File Explorer with the user's documents folder.
.EXAMPLE
PS> ./open-documents-folder
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
try {
$TargetDir = resolve-path "$HOME/Documents"
if (-not(test-path "$TargetDir" -pathType container)) {
throw "Documents folder at 📂$TargetDir doesn't exist (yet)"
}
& "$PSScriptRoot/open-file-explorer.ps1" "$TargetDir"
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-12-09 16:19:09 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of open-documents-folder.ps1*