Difference between revisions of "love.filesystem.read"

(Added new 0.11 variant)
m (Function: fixed love 11.0 version number)
Line 17: Line 17:
  
 
== Function ==
 
== Function ==
{{newin|[[0.11.0]]|110|type=variant}}
+
{{newin|[[11.0]]|110|type=variant}}
 
Reads the contents of a file into either a string or a [[FileData]] object.
 
Reads the contents of a file into either a string or a [[FileData]] object.
 
=== Synopsis ===
 
=== Synopsis ===

Revision as of 15:41, 18 April 2018

Read the contents of a file.

Function

Synopsis

contents, size = love.filesystem.read( name, size )

Arguments

string name
The name (and path) of the file.
number size (all)
How many bytes to read.

Returns

string contents
The file contents.
number size
How many bytes have been read.

Returns (if error on reading)

nil contents
returns nil as content.
string error
returns an error message.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Reads the contents of a file into either a string or a FileData object.

Synopsis

contents, size = love.filesystem.read( container, name, size )

Arguments

ContainerType container
What type to return the file's contents as.
string name
The name (and path) of the file
number size (all)
How many bytes to read

Returns

value contents
FileData or string containing the file contents.
number size
How many bytes have been read.

Returns (if error on reading)

nil contents
returns nil as content.
string error
returns an error message.

See Also


Other Languages