X file:read: Difference between revisions

From GiderosMobile
m Text replacement - "<source" to "<syntaxhighlight"
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''Available since:''' Gideros 2011.6<br/>
'''Available since:''' Gideros 2011.6<br/>
'''Class:''' [[file]]<br/>
'''Class:''' [[X File]]<br/>


=== Description ===
=== Description ===
Line 7: Line 7:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
(string) = file:read(format1,...)
(string) = file:read(format1,...)
</source>
</syntaxhighlight>


For each format, the function returns a string (or a number) with the characters read, or nil if it cannot read data with the specified format.
For each format, the function returns a string (or a number) with the characters read, or nil if it cannot read data with the specified format.
Line 18: Line 18:
*"*l": reads the next line (skipping the end of line), returning nil on end of file. This is the default format.
*"*l": reads the next line (skipping the end of line), returning nil on end of file. This is the default format.
*number: reads a string with up to this number of characters, returning nil on end of file. If number is zero, it reads nothing and returns an empty string, or nil on end of file.
*number: reads a string with up to this number of characters, returning nil on end of file. If number is zero, it reads nothing and returns an empty string, or nil on end of file.
'''note: format "*all" is also valid for "*a"'''


=== Parameters ===
=== Parameters ===
Line 26: Line 28:
'''Returns''' (string) read string from file<br/>
'''Returns''' (string) read string from file<br/>


{{File}}
=== Example ===
<syntaxhighlight lang="lua">
local f = io.open(file, "rb")
if f == nil then
return nil
end
local line=f:read("*all")
f:close()
</syntaxhighlight>
 
{{X File}}

Latest revision as of 20:18, 17 September 2026

Available since: Gideros 2011.6
Class: X File

Description

Reads a file according to given formats which specify what to read.

(string) = file:read(format1,...)

For each format, the function returns a string (or a number) with the characters read, or nil if it cannot read data with the specified format.

When called without formats, it uses a default format that reads the entire next line (see below).

The available formats are:

  • "*n": reads a number; this is the only format that returns a number instead of a string
  • "*a": reads the whole file, starting at the current position. On end of file, it returns the empty string
  • "*l": reads the next line (skipping the end of line), returning nil on end of file. This is the default format.
  • number: reads a string with up to this number of characters, returning nil on end of file. If number is zero, it reads nothing and returns an empty string, or nil on end of file.
note: format "*all" is also valid for "*a"

Parameters

format1: (string) format
...: (string) more optional formats optional

Return values

Returns (string) read string from file

Example

local f = io.open(file, "rb")
if f == nil then
	return nil
end
local line=f:read("*all")
f:close()