PowerShell/docs/open-documents-folder.md
2024-08-15 09:51:46 +02:00

61 lines
1.4 KiB
Markdown

Script: *open-documents-folder.ps1*
========================
This PowerShell script launches the File Explorer with the user's documents folder.
Parameters
----------
```powershell
PS> ./open-documents-folder.ps1 [<CommonParameters>]
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
Example
-------
```powershell
PS> ./open-documents-folder
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.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
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of open-documents-folder.ps1 as of 08/15/2024 09:50:51)*