Difference between revisions of "love.filesystem.getSize"

(Created page)
 
m (Changed version number from 0.11.0 to 11.0)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
 +
{{deprecatedin|[[11.0]]|110|type=function|text=This function is deprecated and is replaced by [[love.filesystem.getInfo]]}}
 
Gets the size in bytes of a file.
 
Gets the size in bytes of a file.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
size = love.filesystem.getSize( filename )
+
size, errormsg = love.filesystem.getSize( filename )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
Line 10: Line 11:
 
=== Returns ===
 
=== Returns ===
 
{{param|number|size|The size in bytes of the file, or nil on failure.}}
 
{{param|number|size|The size in bytes of the file, or nil on failure.}}
{{param|string|errormsg|The error message on failure.}}
+
{{param|string|errormsg (nil)|The error message on failure.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.filesystem]]
 
* [[parent::love.filesystem]]

Latest revision as of 18:25, 3 April 2018

Available since LÖVE 0.9.0
This function is not supported in earlier versions.
Deprecated in LÖVE 11.0
This function is deprecated and is replaced by love.filesystem.getInfo.

Gets the size in bytes of a file.

Function

Synopsis

size, errormsg = love.filesystem.getSize( filename )

Arguments

string filename
The path and name to a file.

Returns

number size
The size in bytes of the file, or nil on failure.
string errormsg (nil)
The error message on failure.

See Also

Other Languages