DGL Statement Reference : INCLUDE

INCLUDE

Description
Copies the text of the specified file to an output segment file. The text is passed to the file verbatim and can contain formatting commands for the format processor used to produce the formatted document.
The file can be an include file within Statemate or a file outside Statemate in the general file system of the host computer.
Syntax
INCLUDE (file_description [, status])
Parameters
 
A file name or an identifier of type FILE. When it is a file name, it can be any string expression, such as a literal string inside quotes (for example, ‘ABC’) or an evaluated expression that produces a file name (for example, a variable that contains a file name).
The file name can include the directory path name of the file, using the file name conventions of the host operating system. If you do not specify the path name, the Documentor searches the workarea for the file.
When the file_description is a file identifier, the file from which you are copying text must first be opened with an OPEN statement in OUTPUT mode (see OPEN).
stm_success—Successful execution of the statement.
stm_error—Failure.
Example
In this example, a UNIX file external to Statemate is included in the output segment:

INCLUDE(’/usr/group/gx_file’);

See Also