ArborX


run

Longname: run   Open the Documentation Legend
Released: not available 
Created: not available 
See also: savevars trun tsavetxt tsavehtm

Summary
Allows Arbortext APP to take a list of macros from a file and act upon them. Almost every Arbortext APP file, including document .3d files; are in fact macro files. A macro file cannot contain another run macro unless it is at the end. If you want to make your own macro files (for example, to set Arbortext APP up in a particular way) we suggest using a file extension of .3m for the sake of consistency.
Example extract

The examples shown below restore the variables stored in the examples given for savevars:

 run "c:/all_vars.3m"

This example restores the variables that have been saved to a file called all_vars.3m.

 run "myvars.3m"

The above example restores the variables that have been saved to a file called myvars.3m.

 run "d:/3d/types.3m"

Restores the variables that have been saved to a file called types.3m in the folder d:/3d/.


Syntax (SVNNA)
macro file:s

The full name and path of the macro file to be run.

The run macro is used to run a macro file which has been saved to disc as, typically, an ASCII text stream using the tsavetxt macro. A macro file differs from the scripts included in a strings file in that there is no string header and each line is presented without a leading $ or ending <>. Apart from this structural difference, a macro file cannot access script features such as loops and jumps and is, in fact, restricted to exactly the same macro commands you can enter in the macro bar.

Despite these limitations, macro files can be very useful. You could, for instance, run a macro file from a document startup script (autoexec.sc) to load tags from a master template document or update text with information from a database. Macro files are also, of course, easier to write than scripts and are worthwhile if you find yourself repeating certain sequences of complicated macros in your work with Arbortext APP.


Document created on 08-Feb-2003 (revision 1)