File-Related Functions

Note:

File-related functions return zero (0) if successful; otherwise, they return the system error code.

Table 48. File-Related Functions

Function

Description

delete

Deletes filename.

Syntax: stat_var = delete(filename)

  • filename = text literal, column, variable, or expression.

  • stat_var = decimal, float, or integer variable.

Example: let #fstatus = delete($filename)

exists

Determines if filename exists.

Syntax: stat_var = exists(filename)

  • filename = text literal, column, variable, or expression.

  • stat_var = decimal, float, or integer variable.

Example: let #fstatus = exists($filename)

filesize

Accepts the name of an external file and returns the number of bytes it contains. If the file size cannot be determined, -1 is returned.

Syntax: dst_var = filesize(source_value)

  • source_value = text literal, column, variable, or expression

  • dst_var = decimal, float, or integer variable

Example: let #size = filesize($file)

rename

Renames old_filename to new_filename.

Syntax: stat_var = rename(old_filename, new_filename)

  • old_filename = text literal, column, variable, or expression

  • new_filename = text literal, column, variable, or expression

  • stat_var = decimal, float, or integer variable

Example: let #fstatus = rename($old_filename, $new_filename)