Purpose
 

CLEAR_INTERNAL_FILE clears a file.

Syntax
 

CLEAR_INTERNAL_FILE(<filename>, [<lower case flag>])

Operation

< filename > Name only of the file (Path and extension are deduced)

<lower case flag> One byte string

"1" - allows filename to be converted to lowercase

"0" - does not allow filename to be converted to lowercase.

Remarks

Returns:

1 - File cleared

-1 - File cannot be cleared

A file can only be cleared if it has read/write permissions on it. Only the platform operating system protects a shared file from being cleared.

Example

#RC = CLEAR_INTERNAL_FILE("example")

All Internal File Verbs write information messages to the system log.

It is recognised that not all the FSI drivers support all the internal File Verbs functions. Accordingly, error codes are returned as appropriate.

Comment on this topic

Topic ID: 520194