RENAME_INTERNAL_FILE |
DEVELOPER |
|
|
Purpose |
RENAME_INTERNAL_FILE renames a file. |
Syntax |
RENAME_INTERNAL_FILE(<filename>, <Newfilename>, [<lower case flag>]) |
Operation |
<filename> Original name of the file <newfilename> Name of the file after the rename has completed. <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 renamed -1 - File cannot be renamed The file is always created with Read and Write access. The effect of the operation is: <DataPro><filename>.<default extension> => <DataPro><newfilename>.<default extension> |
Example |
#RC = RENAME_INTERNAL_FILE("example", "rename", "1") |
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.
Topic ID: 520200