FILECOPY - Copy File

Topic: DMD0384

Help File Version: 2.10.0.636

FILECOPY - Copy File

The Copy File (FILECOPY) instruction is used to make a copy of the contents of a file on one of the file systems to a second file on one of the file systems.

Note: you cannot use the FILECOPY instruction on a destination file that is currently open, and you should not use the FILECOPY instruction on a source file that is currently open.

Source File System - specifies which of the available file systems has the source file.

@RamFS - the 1 MB file system in the Do-more CPU's system RAM. All Do-more CPUs will have this file system available.

@SDCardFS - on PLC systems that have the micro-SD card slot, this selection is the file system on the removable media in that slot.

Source File Name - the full path (including any directories) of the file to copy from on the selected file system. This can be any text enclosed in double quotes, or any system or user-defined string.

Destination File System - specifies which of the available file systems to store the destination file.

@RamFS - the 1 MB file system in the Do-more CPU's system RAM. All Do-more CPUs will have this file system available.

@SDCardFS - on PLC systems that have the micro-SD card slot, this selection is the file system on the removable media in that slot.

Destination File Name - the full path (including any directories) of the file to copy to on the selected file system. This can be any text enclosed in double quotes, or any system or user-defined string.

Append To Destination File - what to d o if the destination file exists.

if enabled and the destination file exists, the contents of the source file will be appended to the contents of the destination file.

if not enabled and the destination file exists, the contents of the destination file will be deleted and replaced with the contents of the source file.

Delete Source File When Done - optionally delete the source file after the file is successfully copied. If the copy operation is not successful the source file will NOT be deleted.

The On Success and On Error parameters specify what action to perform when this instruction completes. You do not have to use the same type of selection for both On Success and On Error.

If the Set Bit selection is used for either On Success or On Error, the specified BIT location will be SET OFF when the instruction is first enabled and will remain OFF until the instruction completes. Once complete, the appropriate Success or Error bit location will be set ON. The specified Bit location is enabled with a SET (Latch) operation (not an OUT operation) meaning that it will remain ON even if this instruction's input logic goes OFF.

If the JMP to Stage selection is used for either On Success or On Error the target Stage must be in the same Program code-block as this instruction, you cannot specify a target Stage that exists in a different Program code-block. When the operation finishes, the target Stage will be enabled the same way as a standalone Jump to Stage (JMP) instruction would do it. The JMP to Stage option will only be selectable if this instruction is placed in a Program code-block.

On Success selects which of the following actions to perform if the operation is successful:

Enable Set Bit then specify any writable bit location.
Enable JMP to Stage then specify any Stage number from S0 to S127 in the current Program code-block.

On Error selects which of the following actions to perform if the operation is unsuccessful:

Enable SET Bit then specify writable bit location.
Enable JMP to Stage then specify any Stage number from S0 to S127 in the current Program code-block.

If either the On Success or On Error selections are set to JMP to Stage, Automatically create the SG box for any NEW stage number will be enabled which will automatically create any target stage that does not already exist.

Below this rung will create the new target stage on a new rung following this instruction.
At end of code-block will create the new target stage on the last rung of this Program.

Error Codes

Improper use of any FILE instruction or any file system hardware problem will generate a warning message at runtime. When any of these warnings are generated, the On Error parameter in the instruction will be ON and the System ERR variable will contain one of the following text messages. You will also be alerted to this condition by yellow "Warning" text displayed in the Status Bar of Do-more Designer. Clicking that text will open the System Status to display the full text of the warning message.

Text displayed in the ERR System variable

How To Solve / What To Do

SdCard not installed, or has an error

On PLC systems that have an SD Card slot, this indicates the SD card is either missing or an error occurred while trying to mount the file system on that media.

Note: you can use the File System structure's .MediaInstalled and .MediaMounted in permissive contacts with the input logic of the FILEOPEN instruction to make sure the removable media is properly installed and available before an attempt is made to execute the instruction.

File wasn't found

The source File Name specified could not be located not on the specified File System. It could be spelled wrong, or it could be located in a sub-folder that is not specified, or located on a different File System.

File access denied

An attempt to copy to a destination file that is marked as either Read-Only or as a System file.

File system is full

There is insufficient space on the specified destination File System to perform the copy operation.

Status Display

The red triangle in the upper left corner of the status display indicates this is a Fully Asynchronous instruction.

The gray triangle at the right end of the input leg indicates the input is edge-triggered, meaning this instruction will execute each time the input logic transitions from OFF to ON.