DeleteShortcut (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

DeleteShortcut (Function)

In french: SupprimeRaccourci

Deletes a shortcut previously created by CreateShortcut from the Windows desktop, from the "Start" menu of Windows or from a specific directory.

Example

// Creates the "Test" shortcut for the "C:\Test\Test.exe" program
// on the desktop, with Ctrl-Alt-A as shortcut
CreateShortCut(shortcutDesktop, "Test", "C:\Test\Test.exe", "", swsNormal, "A")
...
DeleteShortCut(shortcutDesktop, "Test")

// Create the shortcut in "Start/Programs/Accessories"
CreateShortCut(shortcutProgram, "Test", "C:\Test\Test.exe", "Accessories", swsNormal, "A")
...
DeleteShortCut(shortcutProgram, "Test")

Syntax

<Result> = DeleteShortCut(<Location> , <Name> [, <Path>])

<Result>: Boolean

True if the shortcut was deleted,
False if a problem occurred.

<Location>: Integer constant

Relative location of the shortcut path:
shortcutDesktop
(Default value) Shortcut on the Windows desktop.
In Windows Vista, the application that deletes the shortcut must have an administrator manifest.
Versions 22 and later
shortcutUserDesktop
New in version 22
shortcutUserDesktop
shortcutUserDesktop Shortcut on the Windows desktop for the current user of the computer.
Versions 22 and later
shortcutStartup
New in version 22
shortcutStartup
shortcutStartup Shortcut in the "Start .. Programs .. Startup" menu of Windows for all the users of the computer.
Versions 22 and later
shortcutUserStartup
New in version 22
shortcutUserStartup
shortcutUserStartup Shortcut in the "Start .. Programs .. Startup" menu of Windows for the current user of the computer.
Versions 22 and later
shortcutStart
New in version 22
shortcutStart
shortcutStart Shortcut in the "Start" menu of Windows for all the computer users.
Versions 22 and later
shortcutUserStart
New in version 22
shortcutUserStart
shortcutUserStart Shortcut in the "Start" menu of Windows for the current user of the computer.
shortcutQuickLaunch Shortcut in the quick launch bar (Windows 98 and later).
shortcutFree Shortcut in the directory specified by <Path>.
shortcutProgram Shortcut in the "Start .. Programs" menu of Windows.
In Windows Vista (and higher), the application removing the shortcut must have an administrator manifest.
Versions 22 and later
shortcutUserProgram
New in version 22
shortcutUserProgram
shortcutUserProgram Shortcut in the "Start .. Programs" menu of Windows for the current user of the computer.

<Name>: Character string

Name of shortcut.

<Path>: Optional character string

Directory relative to the <Location> from where the shortcut must be deleted. If <Location> = shortcutFree, the path is absolute.

If this parameter is not specified or if it corresponds to an empty string (""), the shortcut will be deleted from the specified <Location>.

Component: wd270std.dll