The following variables can be used in commands (and variables) of any VCS profile. Their values are dynamically assigned each time the command containing them is run.
ROOTDIR
- The full path from the root directory from the mounted
filesystem. This string is taken from the
Working Directory field in the Customizer dialog box when you mount the filesystem.MODULE
- The relative mount point in the directory.FILE
- The name of the file on which the command was issued.DIR
- The pathname from the mounted directory to the directory containing the selected node,
not including the name of the mounted directory, the relative mount point, or the
the selected node. For example, if you have mounted C:\mybigproject
and set
a relative mount point of src
and have selected the node
org/bigpackage/littlepackage
, DIR will resolve to org/bigpackage
.PATH
-
concatenation of DIR and FILE variables.PATHS
- When multiple files are selected (or multiple files are represented
by a single selected node), the path for each file is listed, delimited by two system separators (${PS}${PS}
).QPATHS
- Same as the PATHS variable, except that each entry is enclosed in
double quotes (").MPATHS
- Same as the PATHS variable, except that each entry includes the
module name at the beginning of the path.QMPATHS
- Same as the QPATHS variable, except that each entry includes the
module name at the beginning of the path.FILE_IS_FOLDER
- If the selected node is a directory, the string true
is returned. Otherwise, an empty string (""
) is returned.NUM_FILES
- The number of files represented by the selection. This variable
returns a value of 1 if the Can Run on Multiple Files property is set to False.
Some nodes represent multiple files. However, for .class
files to
be included, the Process All Files property of the command has to be set to
True. For example, if one node is
selected and that node represents a .java
file, a .form
file,
and a .class
file, the
value of NUM_FILES is 2 (if the Process All Files property is set to False) or 3
(if the Process All Files property is set to True).
MULTIPLE_FILES
- If the value of NUM_FILES is greater than 1, the string
"true" is returned. Otherwise, an empty string ("") is returned.
ENVIRONMENT_VAR_variablename
- Returns the value of the
environment variable represented by variablename.CONFIRMATION_MSG
- The string used when prompted for confirmation that the
chosen command should be run. The value of this variable is obtained from the Confirmation Message
Before Execution property of the given command.INSERT_ERROR_OF_commandname
- Allows you to use the error message generated
by a failed command.INSERT_OUTPUT_OF_commandname
- Allows you to use the output generated
by a command.FS_DISPLAY_NAME
- Text that is prefixed to the display name of the filesystem.See also | |
---|---|
Variables in VCS Commands Creating a New Variable Variable Syntax and Usage Configuring the VCS Profile Customizer Substitution Formats for Variables |