FileGetSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 17: Line 17:
==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function()
local newFile = fileCreate("test.txt")                -- attempt to create a new file
local newFile = fileCreate("test.txt")                -- attempt to create a new file
if (newFile) then                                      -- check if the creation succeeded
if (newFile) then                                      -- check if the creation succeeded
fileWrite(newFile, "This is a test file!")        -- write a text line
fileWrite(newFile, "This is a test file!")        -- write a text line
local size = fileGetSize ( newFile )              -- get size
local size = fileGetSize ( newFile )              -- get size
if size then
if size then
outputChatBox("Size of test.txt is: " .. size, source) -- output size
outputChatBox("Size of test.txt is: " .. size, source) -- output size
else
else
outputChatBox("Sorry, test.txt dont have size ;)", source)
outputChatBox("Sorry, test.txt dont have size ;)", source)
        end
                end
fileClose(newFile)                                -- close the file once you're done with it
fileClose(newFile)                                -- close the file once you're done with it
end
end
end
</syntaxhighlight>
</syntaxhighlight>

Revision as of 12:15, 25 May 2010

Returns the total size in bytes of the given file.

Syntax

int fileGetSize ( file theFile )

Required Arguments

  • theFile: the file handle you wish to get the size of.

Returns

Returns the file size if successful, or false if an error occured (e.g. an invalid file handle was passed).

Example

local newFile = fileCreate("test.txt")                -- attempt to create a new file
if (newFile) then                                       -- check if the creation succeeded
	fileWrite(newFile, "This is a test file!")        -- write a text line
	local size = fileGetSize ( newFile )              -- get size
	if size then
		outputChatBox("Size of test.txt is: " .. size, source) -- output size
	else
		outputChatBox("Sorry, test.txt dont have size ;)", source)
        end
	fileClose(newFile)                                -- close the file once you're done with it
end

See Also