Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Latest commit

 

History

History
94 lines (60 loc) · 2.86 KB

HelpersInstallChocolateyDesktopLink.md

File metadata and controls

94 lines (60 loc) · 2.86 KB
Raw

Install-ChocolateyDesktopLink

DEPRECATED - This adds a shortcut on the desktop to the specified file path.

Syntax

Install-ChocolateyDesktopLink `
  -TargetFilePath <String> `
  [-IgnoredArguments <Object[]>] [<CommonParameters>]

Description

Determines the desktop folder and creates a shortcut to the specified file path. Will not throw errors if it fails.

It is recommended you use Install-ChocolateyShortcut instead of this method as this has been deprecated.

Notes

Deprecated in favor of [[Install-ChocolateyShortcut|HelpersInstallChocolateyShortcut]]. If this errors, such as it will if being installed under the local SYSTEM account, it will display a warning instead of failing a package installation.

Will not throw an error if it fails.

Aliases

None

Examples

EXAMPLE 1

# This will create a new Desktop Shortcut pointing at the NHibernate
# Profiler exe.
Install-ChocolateyDesktopLink -TargetFilePath "C:\tools\NHibernatProfiler\nhprof.exe"

Inputs

None

Outputs

None

Parameters

-TargetFilePath <String>

This is the location to the application/executable file that you want to add a shortcut to on the desktop. This is mandatory.

Property Value
Aliases
Required? true
Position? 1
Default Value
Accept Pipeline Input? false

-IgnoredArguments [<Object[]>]

Allows splatting with arguments that do not apply. Do not use directly.

Property Value
Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters http://go.microsoft.com/fwlink/p/?LinkID=113216 .

Links

  • [[Install-ChocolateyShortcut|HelpersInstallChocolateyShortcut]]

[[Function Reference|HelpersReference]]

NOTE: This documentation has been automatically generated from Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyDesktopLink -Full.

View the source for Install-ChocolateyDesktopLink