catalog

catalog


cat Index Level cd
Syntax catalog file.reference itemlist*
Category TCL
Type Verb
Description creates a "verb" entry in the md of the current account, making the specified program executable directly from the TCL prompt.

If the cataloged program is a "mainline" program (not a subroutine or function), it can be executed by issuing its program.name at the TCL prompt.

"file.reference" names the file containing the program to catalog. In D3, if no file is specified, it defaults to "bp".

"itemlist*" names the previously compiled FlashBASIC program(s) to add to the master dictionary. If no itemlist* is specified, or if an asterisk (*) is used, all programs in the file are cataloged.

Once a program has been cataloged, it does not need to be cataloged again, even if it is changed and recompiled. (Issuing the catalog command from TCL is the same as using the <ctrl>+xc on a FlashBASIC program in UP.)

If there is currently a cataloged program with the same name, it is overwritten.

All external subroutines must be cataloged.

Activating a cataloged FlashBASIC program :  

program.name {(options}

To activate a cataloged program, enter the program name at the TCL prompt character. All options available to the "run" command are allowed.
Options o  Overwrites any existing item except file-defining items and Q-pointers.  A cataloged FlashBASIC program item in the master dictionary has its name specified in attribute 4. If an item already exists in the master dictionary that is not in FlashBASIC verb format and the "o" option has not been specified, an error message displays indicating that the item is already on file and the program is not cataloged.

*  See the "run" verb for additional options.
See Also file.reference DEBUG compile-run compile-catalog
Example catalog bp testprog
[244] 'testprog' cataloged.

The "TCL" command sentence to catalog the "testprog" object in the dictionary of file "bp".
Warnings If an item exists in the md with the same name as the program and it is NOT a cataloged program pointer item, the catalog process fails and does not write over the conflicting md item. See the "o" option.

On R83 and all D3 platforms, a program may be cataloged without the source being present.
Compatibility D3 7.0 AP R83 3.1
cat Index Level cd