File.Copy |
  
|
File.Copy |
|
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” (see description of File.GetProperty).
Inputs:
xExecute
|
BOOL |
|
xAbort |
BOOL |
|
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 |
Outputs:
xDone
|
BOOL |
|
xBusy |
BOOL |
|
xError |
BOOL |
|
xAborted |
BOOL |
|
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 read bytes; this value is already valid before xDone has been set |