C$COPY

The C$COPY library routine copies a file to a destination.

FILE-PREFIX settings are ignored by this routine.

Syntax:

CALL "C$COPY" USING sourceFile                       destinationFile                     [fileType]               GIVING returnCode

Parameters:

sourceFile	PIC X(n)	Specifies the source file name.   If the file name starts with "@[DISPLAY]:", the file will be read from the client in an Application Server.   If the file name starts with "isf://", the file will be read from the File Server specified in the name. See The ISF protocol for more information.
destinationFile	PIC X(n)	Specifies the destination file name.   If the file name starts with "@[DISPLAY]:", the file will be copied to the client in an Application Server.   If the file name starts with "isf://", the file will be copied to the File Server specified in the name. See The ISF protocol for more information.
fileType	PIC X(1)	Specifies the file type. Valid values are:   "I" File is Indexed. "R" File is Relative. "RX" File is Relative. Copy file attributes as well. "S" File is Sequential, the default. "SX" File is Sequential. Copy file attributes as well. “T” File is Line Sequential, handle CR/LF.   File type "I" is useful in cases where the original file is held in more than one physical disk file (for example, JIsam and c-tree files are physically held in two separate files). With File type "I" the file name is passed to the indexed file handler APIs so it must be suitable for them. For example, if the file handler is JIsam, avoid the "dat" extension. The routine retrieves input file and ouput file full paths according to the current working directory, so it’s not suitable to copy files that reside on a remote file server (e.g. c-tree and isCOBOL File Server). If you have this need, rely on C$FSCOPY. If the copy of the indexed file is performed in a thin client environment, then it’s important to have the same file.index setting on both client and server, otherwise a file conversion will occur.   File type "T" is useful while copying a line sequential file between client and server and the line separator of the server operating system is different from the line separator of the client operating system (for example between Linux and Windows). C$COPY will take care of this creating a new line sequential file with the proper line separator on the destination system.   The source file attributes such as the last modification date and time are not applied to the destination file unless the type parameter is set to "SX" or "RX".

Return code:

returnCode can be any numeric data item and provides additional information:

0	Operation successful, the file has been copied.
1	An error occurred. Neither the input file nor the output file had "@[DISPLAY]:" in their name. The file has not been copied correctly.
2	An error occurred. Either the input file or the output file had "@[DISPLAY]:" in their name. The file has not been copied correctly.
3	Invalid or missing parameter.

Examples:

Example - Copy file from server to client when running in thin-client mode and backup report on server only

working-storage section. 77 sourceFile pic x(256). 77 destFile   pic x(256). 77 retCode    pic s9(9).   procedure division. ... copy-report-to-client.    move "/myapp/reports/custlist.txt" to sourceFile    move "@[DISPLAY]:c:\tmp\reports\custlist.txt" to destFile    call "c$copy" using sourceFile destFile           giving retCode.    if retCode not = 0       display message "Copy failed with error : " retCode    else       display message "File was copied"    end-if.   backup-report.    move "/myapp/reports/custlist.txt" to sourceFile    move "/myapp/backups/reports/custlist.txt" to destFile    call "c$copy" using sourceFile destFile           giving retCode.    if retCode not = 0       display message "Backup failed with error : " retCode    else       display message "File was backed up"    end-if.