## Restore Variables

This function is used to restore selected variables from named variables. The function is intended to be used to restore variables that you saved via a Save Variables function.

The supplied variable name prefix is case insensitive and may contain any characters except >. Leading and trailing spaces are ignored in the variable name.

The variable name prefix field may contain any of the escape sequences described in Escape Sequences.

The function has two distinct methods of restoring variable values.

Per track values not set:

> The selected variables will be restored from named variables:

> > name prefix-#

> where # is the associated variable number.
> In stepwise execution mode the restored variables of every file will be set to the same values. This is an important consideration. Every track has ten variables but the set of named variables is unique across all files. The combination of Per track values not set and stepwise execution mode only makes sense when the nature of your action guarantees the same variable values across all files. When the variables can be assumed consistant across all files, this mode is far more efficient than the next.

Per track values set:

> The selected variables will be restored from named variables:

> > name prefix-@.#

> where @ is a tracks's index in the current list of selected files and # is the associated variable number.
> Regardless of the the current execution mode, this setting will restore all specified variables treating each track's variables as unique. Note that this can amount to ten variables per track.

When executing Groupwise the mode you choose for Per track values is typically irrelevant.

When executing Stepwise, you should always set Per track values the same as you did in the Save Variables statement which saved the variable's values.

Named variables are removed when action processing terminates. If you are doing a lot of saving and restoring of variables to different named variables, there is some efficiency to be gained by selecting the Remove named variables after restoring option.

Warning: Do not execute a Sort Track List statement inside of a Save and Restore sequence when Per track values is set. The statement will rearrange the track indexes.