From 265313abaa2112463c7e5f87f37a52210bfb3be5 Mon Sep 17 00:00:00 2001 From: kichik Date: Sat, 28 Sep 2002 13:00:14 +0000 Subject: [PATCH] CreateShortCut description added git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1211 212acab6-be3b-0410-9dea-997c60f758d6 --- Docs/src/generalpurpose.but | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/Docs/src/generalpurpose.but b/Docs/src/generalpurpose.but index 10f26ec5..e5f4c9a8 100644 --- a/Docs/src/generalpurpose.but +++ b/Docs/src/generalpurpose.but @@ -36,13 +36,14 @@ The error flag will be set if the file's attributes cannot be set (i.e. the file \S{createshortcut} CreateShortCut -CreateShortCut \e{link.lnk target.file [parameters] [icon.file] [icon_index_number] [start_options] [keyboard_shortcut]} +CreateShortCut \e{link.lnk target.file [parameters [icon.file [icon_index_number [start_options [keyboard_shortcut [description]]]]]]} -Creates a shortcut 'link.lnk' that links to 'target.file', with optional parameters 'parameters'. -The icon used for the shortcut is 'icon.file,icon_index_number'; for default icon settings use empty strings for both icon.file and icon_index_number. -start_options should be one of: SW_SHOWNORMAL, SW_SHOWMAXIMIZED, SW_SHOWMINIMIZED, or an empty string. -keyboard_shortcut should be in the form of 'flag|c' where flag can be a combination (using |) of: ALT, CONTROL, EXT, or SHIFT. c is the character to use (a-z, A-Z, 0-9, F1-F24, etc). Note that no spaces are allowed in this string. A good example is "ALT|CONTROL|F8". $OUTDIR is used for the working directory. -The error flag is set if the shortcut cannot be created (i.e. the path does not exist, or some other error). +Creates a shortcut 'link.lnk' that links to 'target.file', with optional parameters 'parameters'. +The icon used for the shortcut is 'icon.file,icon_index_number'; for default icon settings use empty strings for both icon.file and icon_index_number. +start_options should be one of: SW_SHOWNORMAL, SW_SHOWMAXIMIZED, SW_SHOWMINIMIZED, or an empty string. +keyboard_shortcut should be in the form of 'flag|c' where flag can be a combination (using |) of: ALT, CONTROL, EXT, or SHIFT. c is the character to use (a-z, A-Z, 0-9, F1-F24, etc). Note that no spaces are allowed in this string. A good example is "ALT|CONTROL|F8". $OUTDIR is used for the working directory. +description should be the description of the shortcut, or comment as it is called under XP. +The error flag is set if the shortcut cannot be created (i.e. the path does not exist, or some other error). \S{getfullpathname} GetFullPathName