Copy file

Command group Flag affected Reversible Execute on client Platform(s)
External commands YES NO NO Windows,Linux

Syntax

Copy file (from-path [,to-path]) Returns err-code

Description

Note: The flag is set according to whether Omnis was able to make a call to this external command.

This command makes a copy of the file specified in from-path. The to-path is the path to destination folder into which the file will be copied; the file to be copied must not already exist in the destination folder. If you omit to-path, a copy of the file named in from-path is created in the current directory using the same name with the extension ".BAK".

When constructing the path to a file or folder, you can use sys(9) to insert the correct path delimiter for the current platform: \ (back-slash) on Windows, or / (forward-slash) for Unix and 64-bit macOS (: colon on 32-bit macOS). In addition, you can use sys(115) to return the full pathname of the folder containing the Omnis executable, including the terminating path separator, which might be useful to reference files in the Omnis tree.

It returns an error code (See Error Codes), or zero if no error occurs.

Example

Calculate lPathname as con(sys(115),'html',sys(9),'serverusagetask.htm')
Calculate lNewPath as con(sys(115),'html',sys(9),'serverusagetask2.htm')
Copy file (lPathname,lNewPath) Returns lErrCode ;; copies the file in lPathName to the filename contained in lNewPath