Key Sequence for Tool Parameters

Home » Utilities » Key Sequence for Tool Parameters

A key sequence is a combination of Key Codes and File Codes. A key sequence can be use to pass arguments from µVision to external user programs. Key sequences can be applied to the dialogs in the menus Tools, SVCS, Options for Target — User, or to the command line. The following rules apply:

Certain Key Codes have to be escaped when used from the command line.
To use the symbols $, #, %, @, ~, ^
escape them with $$, ##, %%, @@, ~~, ^^.
Enclose key sequences within quotes (" ") when using folder names that might contain special characters (space, ~, or #).

Available Key Codes and File Codes are listed in the tables below:

Key Code	Description
%	File name with extension, but without path specification (PROJECT1.UVPROJ)
#	File name with extension and complete path specification (C:\MYPROJECT\PROJECT1.UVPROJ)
@	File name without extension or path specification (PROJECT1)
$	Path name of a file. Path names get extended with a backslash. For example, $P could generate C:\MYPROJECT\.
!	File name with extension and relative path specification to the current folder (.\SRC\TEST.C)
~ ¹	Line number of the current cursor position
^ ¹	Column number of the current cursor position

Note

¹ only in combination with the File Code F.

File Code	Description
$D	Device name as selected from the Device Database.
E	Editor file name currently in focus.
F	Depending on the context, this File Code returns: The file selected in the window Project. The currently active editor file. The file that is currently translated by a build process.
H	Application HEX file name (PROJECT1.H86).
$J	Absolute compiler system include folder. Compiler base folders are listed in the fields Project — Manage — Project Items — Folder/Extensions.
K	Absolute root folder of the development toolchain, regardless of the Key Code used.
L	Linker output file. Typically the executable file used for debugging (PROJECT1).
$M	CPU mask revision number.
P	Current project file name.
X	µVision executable program file (..\UV4\UV4.EXE). Works for Key Codes %, #, @.
$X	XTAL clock frequency in MHz as specified in Options for Target — Target — XTAL.
^X	XTAL clock frequency in kHz as specified in Options for Target — Target — XTAL.
File Codes when using an SVCS
Q ²	Name of the temporary file that contains comments (Comment).
R ²	Revision number (Revision).
C ²	Check point string (Check Point).
I ²	Project identification string (Project Ident).
U ²	User name (User Name).
V ²	Database file name string (Database).
File Codes when using a merge tool
	A merge tool gives you the opportunity to merge the application-specific configuration settings from the previous version into the current version. Specify a merge tool with Tools - Configure Merge Tool.
$current	Is the file as copied from the PACK with default configuration options.
$previous	Is the back-up file filename.increment number

Note

² only in combination with the Key Code %.
Examples can be found in the sections: Start External Tools and Using the SVCS Menu.

Environment Variables

You can use environment variables for passing paths to external programs. This is described explicitly in the respective dialog documentation. Environment variables must be enclosed by curly brackets ({ }). For example, you have defined an environment variable with
SET ProgramFiles(x86)=C:\Program Files (x86).

You can use the environment variable as
{ProgramFiles(x86)} in dialog fields.

Key Sequence for Tool Parameters

Environment Variables

Products

Development Tools

Hardware & Collateral

Downloads

Support

Contact

Important information

Privacy Policy Update