FileGetShortcut

Retrieves information about a shortcut (.lnk) file, such as its target file.

FileGetShortcut, LinkFile , OutTarget, OutDir, OutArgs, OutDescription, OutIcon, OutIconNum, OutRunState

Parameters

LinkFile

Name of the shortcut file to be analyzed, which is assumed to be in %A_WorkingDir% if an absolute path isn't specified. Be sure to include the .lnk extension.

OutTarget

If omitted, the corresponding value will not be stored. Otherwise, specify the name of the output variable in which to store the shortcut's target (not including any arguments it might have). For example: C:\WINDOWS\system32\notepad.exe

OutDir

If omitted, the corresponding value will not be stored. Otherwise, specify the name of the output variable in which to store the shortcut's working directory. For example: C:\My Documents. If environment variables such as %WinDir% are present in the string, one way to resolve them is via StrReplace() or StringReplace. For example: StringReplace, OutDir, OutDir, `%WinDir`%, %A_WinDir%.

OutArgs

If omitted, the corresponding value will not be stored. Otherwise, specify the name of the output variable in which to store the shortcut's parameters (blank if none).

OutDescription

If omitted, the corresponding value will not be stored. Otherwise, specify the name of the output variable in which to store the shortcut's comments (blank if none).

OutIcon

If omitted, the corresponding value will not be stored. Otherwise, specify the name of the output variable in which to store the filename of the shortcut's icon (blank if none).

OutIconNum

If omitted, the corresponding value will not be stored. Otherwise, specify the name of the output variable in which to store the shortcut's icon number within the icon file (blank if none). This value is most often 1, which means the first icon.

OutRunState

If omitted, the corresponding value will not be stored. Otherwise, specify the name of the output variable in which to store the shortcut's initial launch state, which is one of the following digits:

Error Handling

[v1.1.04+]: This command is able to throw an exception on failure. For more information, see Runtime Errors.

If there was a problem -- such as LinkFile not existing -- all the output variables are made blank and ErrorLevel is set to 1. Otherwise, ErrorLevel is set to 0.

Remarks

Any of the output variables may be omitted if the corresponding information is not needed.

FileCreateShortcut, SplitPath

Examples

Allows the user to select an .lnk file to show its information.

FileSelectFile, file, 32,, Pick a shortcut to analyze., Shortcuts (*.lnk)
if file =
    return
FileGetShortcut, %file%, OutTarget, OutDir, OutArgs, OutDesc, OutIcon, OutIconNum, OutRunState
MsgBox %OutTarget%`n%OutDir%`n%OutArgs%`n%OutDesc%`n%OutIcon%`n%OutIconNum%`n%OutRunState%