Copy (FB; Prefix filcp)¶

FUNCTION_BLOCK Copy EXTENDS CBM.ETrigToA

This function block copies a file. The target file is created or - if already existent - overwritten. The overwrite mode can be defined with the input ”xOverWrite”. If the overwrite mode is activated, no write protection may be activated in the existing file.

The function block is optional for different targets. Whether this function block is implemented or not is explicitly stated and encoded in the return value of the function ”FILE.GetProperty”.

InOut:

Scope	Name	Type	Initial	Comment	Inherited from
Input	`xExecute`	`BOOL`		Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values (`xDone`, `xError`) are present at the outputs for exactly one cycle.	ETrigToA
	`xAbort`	`BOOL`		`TRUE`: Action is stopped immediately and all outputs are reset to their initial values.	ETrigToA
	`udiTimeOut`	`UDINT`		Defines the time (µs) after which an FB (e.g. requiring an external acknowledgement) aborts operation due to a timeout with error message.	ETrigToA
Output	`xDone`	`BOOL`		`TRUE`: Action successfully completed	ETrigToA
	`xBusy`	`BOOL`		`TRUE`: Function block active	ETrigToA
	`xError`	`BOOL`		`TRUE`: Error occurred, function block aborts action `FALSE`: No error	ETrigToA
	`xAborted`	`BOOL`		`TRUE` : Action aborted by user	ETrigToA
Input	`sFileNameDest`	`CAA.FILENAME`		File to which data should be copied; for restrictions concerning the file- and directory names see FILE_Open (FB)
	`sFileNameSource`	`CAA.FILENAME`		File from which data should be copied, for restrictions concerning the file- and directory names see FILE_Open (FB)
	`xOverWrite`	`BOOL`	TRUE	Overwrite an already existing file; TRUE: yes; FALSE: File will not be overwritten, an error message will be created
Output	`eError`	ERROR		Local library error ID (5105 - FILE_EXIST: Target file already exists; only in case of `xOverWrite := FALSE`)
Output	`szSize`	`CAA.SIZE`		source file size, copied bytes into the destination file