The following codes are used to pass various paths to external programs. The path codes available offer all possible combinations of the following three criteria:
The long form of each code is built from a combination of keywords that reflect the three criteria. If a long code ends in a $ sign it is the "path required" form of the code - it is said to "need" a valid path. Note that the left and right paths do not support the "required" forms.
|
Long form |
Short form |
Description |
|---|---|---|
|
{sourcepath} |
{s!} |
Source path, long filenames, not required. |
|
{sourcepath$} |
{s} |
Source path, long filenames, required. |
|
{destpath} |
{d!} |
Destination path, long filenames, not required. |
|
{destpath$} |
{d} |
Destination path, long filenames, required. |
|
{sourcepathshort} |
{ss!} |
Source path, short filenames, not required. |
|
{sourcepathshort$} |
{ss} |
Source path, short filenames, required. |
|
{destpathshort} |
{ds!} |
Destination path, short filenames, not required. |
|
{destpathshort$} |
{ds} |
Destination path, short filenames, required. |
|
{leftpath} |
{l} |
Left (top) path, long filenames. |
|
{rightpath} |
{r} |
Right (bottom) path, long filenames. |
|
{leftpathshort} |
{ls} |
Left path, short filenames. |
|
{rightpathshort} |
{rs} |
Right path, long filenames. |
In addition to the path codes related to current Lister paths, the following codes allow you to pass the values of certain system or application-specific paths.
|
Long form |
Short form |
Description |
|---|---|---|
|
{apppath} |
{p} |
Returns the path of an installed application, as listed in the App Paths key in the registry. For example, {apppath|winword.exe} would insert the install path of Microsoft Word. |
|
{apppathshort} |
{ps} |
The path of an installed application, in short (8.3) format. |
|
{alias} |
{A} |
Returns the path of a folder alias. For example, {alias|mydocuments} would return the path to your documents folder. |
|
{aliasshort} |
{As} |
The path of a folder alias, in short (8.3) format. |
The path codes support the following modifiers. These can be added to the control code sequence using a vertical bar (|) to separate the filename code from the modifier - for example, {sourcepath|noterm} strips the trailing termination character from the path. Multiple modifiers can be provided using additional vertical bars to separate them - for example {sourcepath|nopath|noterm} combines both nopath and noterm together.
|
Modifier |
Description |
|---|---|
|
escbackslash |
Automatically escapes any occurrences of \ in the path, turning them into \\. This can be neccessary when using codes like {sourcepath} to insert paths into strings which will have sequences like \n and \\ interpreted specially. For example, a command to add the source and destination paths to the
clipboard on separate lines: |
|
escnl |
Automatically escapes any occurrences of \n in the path, turning them into \\n. (This is a weaker version of escbackslash, above. You should probably use escbackslash instead.) Using escnl helps when using codes like {sourcepath} as the message text for a dialog code like {dlgstring}. For example, the path C:\New Folder\ would be converted to C:\\New Folder\. If the \n sequence weren't escaped, it would have been converted into a line-break in the dialog message text. |
|
escregexp |
Automatically escapes any regular expression characters in the path. Used when passing paths to internal commands that understand regular expressions, in case a path contains characters like \, ., ( and ) which have special meaning to some functions. For example, {sourcepath|escregexp|noterm} would turn C:\Accounts (2010)\ into C:\\Accounts \(2010\). |
|
escwild |
Automatically escapes any wildcard characters in the path. Used when passing paths to internal commands that understand standard wildcards, in case a path contains characters like ( and ) which have special meaning to some functions. For example, {sourcepath|escwild|noterm} would turn C:\Accounts (2010)\ into C:\Accounts '(2010'). |
|
nopath |
Returns only the final component of the path. For example, if {sourcepath} returns C:\Program Files\GPSoftware\Directory Opus\, {sourcepath|nopath} would return Directory Opus\. |
|
noroot |
Returns the path without the root, i.e. without the first component. For example, if {sourcepath} returns C:\Program Files\GPSoftware\Directory Opus\, {sourcepath|noroot} would return Program Files\GPSoftware\Directory Opus\. With UNC network paths, the result is relative to the share, with the computer and share itself removed. With FTP paths, the result is relative to the site's root and excludes the site itself. You can combine noroot with .. to get a parent path with the root removed. For example, {sourcepath|..|noroot} |
|
noshort |
Suppresses automatic shortening of paths which are longer than 260 characters. Opus itself can handle very long paths but many Windows programs cannot. When sending very long paths to external programs, Opus normally uses the short (8.3) versions to reduce problems. Use noshort to prevent this when you know the target program can cope. For example, {sourcepath|noshort}. |
|
noterm |
Strips the trailing path separator from the returned path. For example, {sourcepath|noterm} might return C:\Program Files\GPSoftware\Directory Opus. |
|
subdir |
Replaces characters in the path so that it can be added below another path. For example, {sourcepath|subdir} might return C;\Program Files. Note that a semi-colon has replaced the colon, allowing the path to be used as a sub-directory, say if you wanted to backup the files from there into D:\Backups\C;\Program Files. |
|
.. |
Modifies the code to refer to the path's parent rather than the path itself. You can pass multiple .. modifiers separated by \ to return folders higher up the tree. For example {destpath|..\..} would return the parent of the parent of the current destination path. |
|
\ |
Modifies the code to refer to the root of the drive of the specified path. For example {sourcepath|\} might return C:\. |