MTA:Eir/FileSystem/translator/copy: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ This function copy a file from a source location to a file at the destination. This function copies the contents of the source file, so that source and destination have...")
 
mNo edit summary
Line 4: Line 4:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool translator.copy ( string srcPath, string dstPath )
bool translator:copy ( string srcPath, string dstPath )
</syntaxhighlight>
</syntaxhighlight>


Line 21: Line 21:
local resRoot = fileCreateTranslator( "/" );
local resRoot = fileCreateTranslator( "/" );


resRoot.copy( "config.xml", "backup/config.xml" );
resRoot:copy( "config.xml", "backup/config.xml" );
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
{{:MTA:Eir/FileSystem/translator/functions}}
{{:MTA:Eir/FileSystem/translator/functions}}

Revision as of 23:24, 16 January 2022

This function copy a file from a source location to a file at the destination. This function copies the contents of the source file, so that source and destination have the same content. Since the transactions happen through kernel-calls, this function is faster than performing the copying yourself.

Syntax

bool translator:copy ( string srcPath, string dstPath )

Arguments

  • srcPath: a path to the source file
  • dstPath: the path to the new file that should be copied into

Returns

This function returns true if the file pointed at by srcPath is an accessible file that can be read from and the requested file a dstPath could be created and written to, false otherwise.

Example

Click to collapse [-]
Client

This snippet backups a copy of client-side configuration for safety purposes.

-- Create a generic translator.
local resRoot = fileCreateTranslator( "/" );

resRoot:copy( "config.xml", "backup/config.xml" );

FileSystem Translator Functions