Difference between revisions of "(File):read"
m (0.11.0 -> 11.0) |
|||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | Read a number of bytes from a file. | |
| + | == Function == | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | contents, size = File:read( bytes ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|number|bytes (all)|The number of bytes to read.}} | ||
| + | === Returns === | ||
| + | {{param|string|contents|The contents of the read bytes.}} | ||
| + | {{param|number|size|How many bytes have been read.}} | ||
== Function == | == Function == | ||
| + | {{newin|[[11.0]]|110|type=variant}} | ||
| + | Reads the contents of a file into either a string or a [[FileData]] object. | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | contents = File:read( bytes ) | + | contents, size = File:read( container, bytes ) |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | {{param|number|bytes|The number of bytes to read}} | + | {{param|ContainerType|container|What type to return the file's contents as.}} |
| + | {{param|number|bytes (all)|The number of bytes to read.}} | ||
=== Returns === | === Returns === | ||
| − | {{param| | + | {{param|value|contents|[[FileData]] or string containing the read bytes.}} |
| + | {{param|number|size|How many bytes have been read.}} | ||
| + | |||
== See Also == | == See Also == | ||
* [[parent::File]] | * [[parent::File]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description=}} | + | {{#set:Description=Read a number of bytes from a file}} |
| + | {{#set:Since=000}} | ||
| + | == Other Languages == | ||
| + | {{i18n|(File):read}} | ||
Latest revision as of 14:14, 22 December 2018
Read a number of bytes from a file.
Contents
Function
Synopsis
contents, size = File:read( bytes )
Arguments
number bytes (all)- The number of bytes to read.
Returns
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 = File:read( container, bytes )
Arguments
ContainerType container- What type to return the file's contents as.
number bytes (all)- The number of bytes to read.
Returns
value contents- FileData or string containing the read bytes.
number size- How many bytes have been read.
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
