FileGetSize: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(3 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server client function}} | ||
Returns the total size in bytes of the given file. | Returns the total size in bytes of the given file. | ||
Line 8: | Line 8: | ||
int fileGetSize ( file theFile ) | int fileGetSize ( file theFile ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[file]]:getSize|size}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
Line 17: | Line 18: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
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 | |||
end | |||
fileClose(newFile) -- close the file once you're done with it | |||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> |
Revision as of 00:08, 22 January 2016
Returns the total size in bytes of the given file.
Syntax
int fileGetSize ( file theFile )
OOP Syntax Help! I don't understand this!
- Method: file:getSize(...)
- Variable: .size
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 end fileClose(newFile) -- close the file once you're done with it end
See Also
- fileClose
- fileCopy
- fileCreate
- fileDelete
- fileExists
- fileFlush
- fileGetPath
- fileGetPos
- fileGetSize
- fileIsEOF
- fileOpen
- fileRead
- fileRename
- fileSetPos
- fileWrite