copy_filecopy_fileCopyFileCopyFilecopy_file (Operator)
Name
copy_filecopy_fileCopyFileCopyFilecopy_file
— Copy a file to a new location.
Signature
Description
copy_filecopy_fileCopyFileCopyFileCopyFilecopy_file
copies SourceFileSourceFileSourceFileSourceFilesourceFilesource_file
to DestinationFileDestinationFileDestinationFileDestinationFiledestinationFiledestination_file
.
Existing files are silently overwritten. The file attributes of
SourceFileSourceFileSourceFileSourceFilesourceFilesource_file
are kept.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
SourceFileSourceFileSourceFileSourceFilesourceFilesource_file
(input_control) filename.read →
HTuplestrHTupleHtuple (string) (string) (HString) (char*)
File to be copied.
DestinationFileDestinationFileDestinationFileDestinationFiledestinationFiledestination_file
(input_control) filename.write →
HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Target location.
Result
copy_filecopy_fileCopyFileCopyFileCopyFilecopy_file
returns the value 2 (
H_MSG_TRUE)
if the file could be copied.
Otherwise, an exception is raised.
Module
Foundation