This function block of the ⇘ CAA_File.library 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” (see description of ⇘ FILE.GetProperty).
Input:
|
xExecute |
BOOL |
see: ⇘ “CAA 指南” |
|
xAbort |
BOOL |
see: ⇘ “CAA 指南” |
|
udiTimeOut |
UDINT |
|
|
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 |
Overwriting an already existing file with equal name TRUE: File will be overwritten FALSE: File will not be overwritten, an error message will be created |
Output:
|
xDone |
BOOL |
see:Guidlines for CAA libs |
|
xBusy |
BOOL |
see:Guidlines for CAA libs |
|
xError |
BOOL |
see:Guidlines for CAA libs |
|
xAborted |
BOOL |
see:Guidlines for CAA libs |
|
eError |
FILE.ERROR |
Error ID 5105 - FILE.EXIST: - Target file already exists; only in case of xOverWrite := FALSE |
|
szSize |
CAA.SIZE |
Current number of successfully copied bytes; this value is already valid before xDone is set |