FORMAT DEFAULT

Initialize Format Data Elements and Load Values

This directive initializes the value of all data elements and loads any defaults for a selected format or for all formats that have been INCLUDEd.

Syntax

FORMAT DEFAULT format-name[,OPT = "DFONLY"]
[,ERR=line-ref|,ERC=error-code]

FORMAT DEFAULT ALL [,OPT = "DFONLY"]
[,ERR=line-ref|,ERC=error-code]

format-name

is the name of a format defined in the data dictionary.

OPT = "DFONLY"

is an optional modifier that bypasses the normal initialization process, and loads any existing defaults only if the data element's value is at an initialized state.

line-ref

is the program line number or label to branch to if an error is produced.

error-code

is a programmer-defined error code. Valid values are positive or negative whole numbers.

Remarks

Alphanumeric fields are initialized with spaces. All numeric fields are initialized with the appropriate zero representation.

An attempt to default the value of a format that has not been INCLUDEd by the current program results in an ERR=162.

Examples

FORMAT DEFAULT #DNFFMT

INITializes and DEFAULTs the data names contained in the format named “DNFFMT”.

FORMAT DEFAULT ALL

INITializes and DEFAULTs the data names of all formats currently INCLUDEd.

FORMAT DEFAULT #DNFFMT ,OPT="DFONLY"

bypasses normal initialization and loads existing defaults if the data element’s value is at an initialized state.

See also

FORMAT DELETE, FORMAT INCLUDE, and FORMAT INIT directives

From the Thoroughbred Basic Language Reference, Volume II: F–Q, version 8.9.1. Open this page in the PDF