Application icon

Set Named Variable

This function is used to set the contents of a named variable. You can optionally choose to set only if the destination is empty and/or only if the source is not empty.

The Variable name is case insensitive and may contain any characters. Leading and trailing spaces are ignored in the variable name. You should not include > characters as their presence will make it difficult to access via escape sequence. If a > character is contained in the name you will only be able to access the named variable's contents by indirectly loading it through a different variable or named variable.

Both the name and value fields may contain any of the escape sequences described in Escape Sequences.

Named variables are accessed from within text fields which support escape sequences. The sequence is: \<variable name>.

Note that when using escape sequences in the name field, it is possible to create a named variable with an empty name or one which contains a > character. You will not be able to easily access these variables. Access to the escape sequence mechanism in the name field is provided so that you can dynamically set named variables.

In stepwise execution mode, this function is only processed for the first file.

Note that action statement text field context menus have an Insert Named Variable submenu. This submenu contains all named variables directly referenced in text fields in all open actions. This is an efficient means of inserting named variables which are currently used. This menu is contextually aware of the intent of a field. When inserting to a field which should contain the name of a named variable, the inserted contents will not be escaped. When the field specifies a value, the inserted contents will be escaped. You can flip the interpretation of the inserted contents while holding down the Shift key.