Changes the name of a file.
Syntax:
call "CBL_RENAME_FILE" using old-filename
new-filename
returning status-code
On Entry:
-
old-filename
- The file to rename. The name can contain a pathname, or a specific
MFDBFH datastore URL(see
The Datastore URL for specific SQL URL syntax), and is terminated by a space. If no path is given, the current directory is assumed.
This routine does not work with filenames containing wildcard characters.
-
new-filename
- The new name, terminated by a space. If
old-filename contains a pathname or URL, this must contain the same pathname or URL. Some operating systems do not allow you to rename
a file if a file of the name in
new-filename already exists
Comments:
CBL_RENAME_FILE is not stripe-aware. If you use this routine on a striped file, the routine renames the first stripe only. Therefore, use this routine on an individual stripe only and refer to the stripe by the stripe name.
You can check the success of the call by examining RETURN-CODE. See the topic Interpreting the return code as a file status code for more details.