PowerShell/Docs/new-symlink.md
2023-05-26 12:20:18 +02:00

80 lines
2.0 KiB
Markdown

## The *new-symlink.ps1* Script
This PowerShell script creates a new symbolic link file.
## Parameters
```powershell
/home/mf/Repos/PowerShell/Scripts/new-symlink.ps1 [[-symlink] <String>] [[-target] <String>] [<CommonParameters>]
-symlink <String>
Specifies the new symlink filename
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-target <String>
Specifies the path to target
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> ./new-symlink C:\Temp\HDD C:\
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Source Code
```powershell
<#
.SYNOPSIS
Creates a new symbolic link file
.DESCRIPTION
This PowerShell script creates a new symbolic link file.
.PARAMETER symlink
Specifies the new symlink filename
.PARAMETER target
Specifies the path to target
.EXAMPLE
PS> ./new-symlink C:\Temp\HDD C:\
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$symlink = "", [string]$target = "")
try {
if ($symlink -eq "" ) { $symlink = read-host "Enter new symlink filename" }
if ($target -eq "" ) { $target = read-host "Enter path to target" }
new-item -path "$symlink" -itemType SymbolicLink -Value "$target"
"✔️ created new symlink $symlink$target"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*Generated by convert-ps2md.ps1 using the comment-based help of new-symlink.ps1*