Difference between revisions of "love.filesystem.read"

(what is returned if error while reading)
(Added new 0.11 variant)
Line 1: Line 1:
−
Read the contents of a file
+
Read the contents of a file.
 +
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 6: Line 7:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 +
{{param|string|name|The name (and path) of the file.}}
 +
{{param|number|size (all)|How many bytes to read.}}
 +
=== Returns ===
 +
{{param|string|contents|The file contents.}}
 +
{{param|number|size|How many bytes have been read.}}
 +
=== Returns (if error on reading) ===
 +
{{param|nil|contents|returns nil as content.}}
 +
{{param|string|error|returns an error message.}}
 +
 +
== Function ==
 +
{{newin|[[0.11.0]]|110|type=variant}}
 +
Reads the contents of a file into either a string or a [[FileData]] object.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
contents, size = love.filesystem.read( container, name, size )
 +
</source>
 +
=== Arguments ===
 +
{{param|ContainerType|container|What type to return the file's contents as.}}
 
{{param|string|name|The name (and path) of the file}}
 
{{param|string|name|The name (and path) of the file}}
 
{{param|number|size (all)|How many bytes to read}}
 
{{param|number|size (all)|How many bytes to read}}
 
=== Returns ===
 
=== Returns ===
−
{{param|string|contents|The file contents}}
+
{{param|value|contents|[[FileData]] or string containing the file contents.}}
−
{{param|number|size|How many bytes have been read}}
+
{{param|number|size|How many bytes have been read.}}
 
=== Returns (if error on reading) ===
 
=== Returns (if error on reading) ===
−
{{param|nil|-|returns nil as content}}
+
{{param|nil|contents|returns nil as content.}}
−
{{param|string|error|returns an error message}}
+
{{param|string|error|returns an error message.}}
 +
 
 
== See Also ==
 
== See Also ==
 
* [[parent::love.filesystem]]
 
* [[parent::love.filesystem]]
 
[[Category:Functions]]
 
[[Category:Functions]]
−
{{#set:Description=Read the contents of a file}}
+
{{#set:Description=Read the contents of a file.}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.filesystem.read}}
 
{{i18n|love.filesystem.read}}

Revision as of 00:37, 31 March 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 0.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

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info

Retrieved from "https://love2d.org./w/index.php?title=love.filesystem.read&oldid=21205"