copy_fileCopyFileCopyFilecopy_filecopy_file
Short description
copy_fileCopyFileCopyFilecopy_filecopy_file — Copy a file to a new location.
Signature
copy_file( filename.read SourceFile, filename.write DestinationFile )void CopyFile( const HTuple& SourceFile, const HTuple& DestinationFile )static void HOperatorSet.CopyFile( HTuple sourceFile, HTuple destinationFile )def copy_file( source_file: str, destination_file: str ) -> None
Herror copy_file( const char* SourceFile, const char* DestinationFile )
Herror T_copy_file( const Htuple SourceFile, const Htuple DestinationFile )
static void HMisc::CopyFile( const HString& SourceFile, const HString& DestinationFile )
static void HMisc::CopyFile( const char* SourceFile, const char* DestinationFile )
static void HMisc::CopyFile( const wchar_t* SourceFile, const wchar_t* DestinationFile ) (Windows only)
static void HMisc.CopyFile( string sourceFile, string destinationFile )
Description
copy_fileCopyFile copies SourceFilesourceFilesource_file to DestinationFiledestinationFiledestination_file.
Existing files are silently overwritten. The file attributes of
SourceFilesourceFilesource_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
SourceFilesourceFilesource_file (input_control) filename.read → (string)HTuple (HString)HTuple (string)strHtuple (char*)
File to be copied.
DestinationFiledestinationFiledestination_file (input_control) filename.write → (string)HTuple (HString)HTuple (string)strHtuple (char*)
Target location.
Result
copy_fileCopyFile returns the value 2 (H_MSG_TRUE) if the file could be copied.
Otherwise, an exception is raised.
Module
Foundation