Core Function FileCopy

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
m (1 revision)
(Return Value)
 
Line 28: Line 28:
  
 
Failure: Returns false if error occurs.
 
Failure: Returns false if error occurs.
 
This function makes use of [[Macros#Error|@Error]] macro.
 
  
 
=== Remarks ===
 
=== Remarks ===

Latest revision as of 21:07, 17 June 2015

FileCopy( <file1>, <file2>, <flag> )

Contents

Description

Copy a file.

Parameters

file1

The file to copy.

file2

The new file name and location.

flag

If the flag is true FileCopy will overwrite any existing file at the location.

Default is not to overwrite.

Return Value

Success: Returns true.

Failure: Returns false if error occurs.

Remarks

None.

Example

FileCopy("Sputnik.exe", "Cats.exe"); // Copy but dont overwrite
FileCopy("Sputnik.exe", "Cats.exe", 1); // Copy but dont DO overwrite

Example using @Error macro

FileCopy("catNotExist.exe", "Dog.exe");
if(@Error)
{
	say("There was an error");
	say("Error code: " . @ErrorCode);
	say("Error message: " . @ErrorMsg);
}
else
{
	say("There was no error");
}
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox