tcl.clear-file

Verb: Access/TCL, Releases: AP and R83

Clears dict or data section of specified file.

Syntax

clear-file {(}{data} file.reference{, file.reference}) {(option} clear-file {(}dict file.reference) {(option}

Description

clears the dictionary or data section of the specified file of all items and retains the primary file space area.

Clears data from the file specified by 'file.reference'. The file is only cleared, not deleted. The file retains its name, base, and modulo for both dictionary and data sections.

To clear the dictionary section, 'dict' must be specified before the 'file.reference'. If 'dict' is specified, file-defining items ('d-pointers') are not cleared.

If no 'level' is specified, the default is 'data'.

Options

c 'Scrubs' each frame of the file's primary space, changing every byte in the frame to x'ff'.
n No logging. When this option is active, no log of the clear-file is placed in the file-of-files item. This can increase performance significantly on temporary files which are cleared frequently.

Example

clear-file data old.invoices
Removes all items from the data level of the 'old.invoices'.

clear-file dict invoice.history
Removes all items except 'd-pointers' to data sections from the
dictionary of the 'invoice.history' file.

clear-file data invoices,archive
Clears the 'archive' data section located in the dictionary of the
'invoices' file.

See Also

Command Name Type Description
tcl.delete-file Verb: Access Deletes file from account.
tcl.create-file Verb: Access Creates a new file.
files Definition Description of Pick file organization.
basic.open Statement Opens file for input and output.
scrubber Definition a mechanism on certain older AP releases to provide overflow protection in the event of a system halt.
file.control.block Definition Description of file control block.
basic.clearfile Statement Clears specified file.variable.

User Comments

What do you think?

Share your experience or ask a question by using the form below.

Login to leave your comments.