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
|
|
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)
|
|
szSize
|
CAA.SIZE
|
|
source file size, copied bytes into the destination file
|
|