Skip to content

FORMAT INCLUDE

FUNCTION

This directive loads the format attributes from the data dictionary into memory, and then initializes the format’s data area. This is a Thoroughbred Basic directive that can be executed from within a script.

SYNTAX

FORMAT INCLUDE format-name [,OPT = option-str] [,ERC=n]
format-name
is the name of a format defined in the data dictionary.
option-str
is either the initialization mode to perform on the format's data area, "INIT", "DEFAULT", or "NONE", or a special include mode to perform on the format, "DESC_TBL". If no option is specified, the data area is initialized.
n
is a numeric value set when an error condition is produced.

NOTES

  • For more information on this Thoroughbred Basic directive see the Thoroughbred Basic Language Reference.

SEE ALSO

FORMAT DEFAULT, FORMAT DELETE, FORMAT INIT, SET ERC. Information on formats in the Dictionary-IV Reference Manual. ATR, ERC, FMD, FMT, LET FMD, LET FMT, and information on formats and related directives in the Thoroughbred Basic Language Reference.

From the Script-IV Language Reference, version 8.9.1. Open this page in the PDF