FileCopy: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Useful Function}} This function copies a file. ==Syntax== <syntaxhighlight lang="lua"> bool fileCopy ( string filePath , string copiedFilePath ) </syntaxhighlight> ===Required Arguments=== * '''filePath'...")
 
mNo edit summary
Line 1: Line 1:
{{Useful Function}}
{{Useful Function}}
This function copies a file.
This function copies a file.{{Note|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.)}}
{{Tip|If you do not want to share the content of the created file with other servers, prepend the file path with @ (See [[filepath]] for more information)}}


==Syntax==
==Syntax==

Revision as of 13:13, 31 August 2012

This function copies a file.

[[{{{image}}}|link=|]] Note: The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.)
[[{{{image}}}|link=|]] Tip: If you do not want to share the content of the created file with other servers, prepend the file path with @ (See filepath for more information)

Syntax

 bool fileCopy ( string filePath , string copiedFilePath ) 

Required Arguments

  • filePath: The path of the file you want to copy.
  • copiedFilePath: The copied filepath.

Returns

Return true if the file was copied, else false if the 'filePath' doesn't exist.

Code

function fileCopy(curName,newName)
	if fileExists(curName) then
		local file = fileOpen(curName)
		if not file then return false end
		local file1 = fileCreate(newName)
		if file1 then
			local fileSize = fileGetSize(file)
			if fileSize==0 then
				fileClose(file1)
				fileClose(file)
				return true
			end
			fileWrite(file1,fileRead(file,fileSize))
			fileClose(file1)
			fileClose(file)
		end
		return true
	end
	return false
end

Example

Click to collapse [-]
Server

This example copies a file called 'test.txt' and called it 'test1.txt'.

addEventHandler("onResourceStart",resourceRoot,function(res)
     if res==getThisResource() then --make sure it's this resource
          local filePath = ":"..getResourceName(res).."/test.txt"
          fileCreate(filePath) --create the file in this resource and name it 'test.txt'.
          if fileCopy(filePath,":"..getResourceName(res).."/test1.txt") then
               outputChatBox("File was successfully copied!",0,100,0)
          else
               outputChatBox("Don't know how this happened but the file was not successfully copied!",100,0,0)
          end
     end
end)
Click to collapse [-]
Client

This example copies a file called 'test.txt' and called it 'test1.txt'.

addEventHandler("onClientResourceStart",resourceRoot,function(res)
     if res==getThisResource() then --make sure it's this resource
          local filePath = ":"..getResourceName(res).."/test.txt"
          fileCreate(filePath) --create the file in this resource and name it 'test.txt'.
          if fileCopy(filePath,":"..getResourceName(res).."/test1.txt") then
               outputChatBox("File was successfully copied!",0,100,0)
          else
               outputChatBox("Don't know how this happened but the file was not successfully copied!",100,0,0)
          end
     end
end)