Extract File Built-in Attributes

Built-in attributes that can be used Extract files are listed in the following table.

Built-in Attribute

Function

<glbfile>.Exists

After using the SetTitle command, or assigning a title to the <glbfile>.Name attribute, set <glbfile>.Exists to True to indicate that the file exists.

The setting of <glbfile>.Exist only affects the implicit opening of the extract file. It does not affect the explicit opening of the extract file by the <glbfile>.Open() method.

<glbfile>.IsTemporary

While an extract file is open, set <glbfile>.IsTemporary to True to indicate that the extract file should be discarded when the extract file is closed implicitly at the termination of the report.

The setting of <glbfile>.IsTemporary does not affect the explicit closing of the extract file by the <glbfile>.close() method.

<glbfile>.Name

Similar to SetTitle.

<glbfile>.Permanent

While an extract file is open, set <glbfile>.Permanent to True to indicate that the extract file should be retained when the extract file is closed implicitly at the termination of the report.

The setting of <glbfile>.Permanent does not affect the explicit closing of the extract file by the <glbfile>.close() method.

Limitation: An extract file cannot be made permanent if a title has not been assigned to it. So, the setting of <glbfile>.Permanent might be ignored. It is preferable to establish the category of the extract file at the time of opening it.

<glbfile>.Record

To read a specific record in the extract file, assign the number of the prior record to <glbfile>.Record.

 Caution

Using the <glbfile>.IsTemporary and <glbfile>.Permanent Extract File Built-in attributes to change the category of an existing file may cause the file to be deleted or overwritten.