Difference between revisions of "Io.open"

From GiderosMobile
Line 2: Line 2:
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
=== Description ===
 
=== Description ===
This function opens a file, in the mode specified in the string mode. It returns a new file handle, or, in case of errors, nil plus an error message.  
+
<translate>This function opens a file, in the mode specified in the string mode. It returns a new file handle, or, in case of errors, nil plus an error message.  
  
  
Line 14: Line 14:
 
"a+": append update mode, previous data is preserved, writing is only allowed at the end of file.
 
"a+": append update mode, previous data is preserved, writing is only allowed at the end of file.
  
  The mode string can also have a 'b' at the end, which is needed in some systems to open the file in binary mode. This string is exactly what is used in the standard C function fopen.
+
  The mode string can also have a 'b' at the end, which is needed in some systems to open the file in binary mode. This string is exactly what is used in the standard C function fopen.</translate>
 
<source lang="lua">
 
<source lang="lua">
 
(file) = io.open(filename,mode)
 
(file) = io.open(filename,mode)
 
</source>
 
</source>
 
=== Parameters ===
 
=== Parameters ===
'''filename''': (string) filename to open <br/>
+
'''filename''': (string) <translate>filename to open</translate> <br/>
'''mode''': (string) mode in which to open the file '''optional'''<br/>
+
'''mode''': (string) <translate>mode in which to open the file</translate> '''optional'''<br/>
 
=== Return values ===
 
=== Return values ===
'''Returns''' (file) file object<br/>
+
'''Returns''' (file) <translate>file object</translate><br/>

Revision as of 13:32, 23 August 2018

Available since: Gideros 2011.6

Description

This function opens a file, in the mode specified in the string mode. It returns a new file handle, or, in case of errors, nil plus an error message.


The mode string can be any of the following: 

"r": read mode (the default); "w": write mode; "a": append mode; "r+": update mode, all previous data is preserved; "w+": update mode, all previous data is erased; "a+": append update mode, previous data is preserved, writing is only allowed at the end of file.

The mode string can also have a 'b' at the end, which is needed in some systems to open the file in binary mode. This string is exactly what is used in the standard C function fopen.
(file) = io.open(filename,mode)

Parameters

filename: (string) filename to open
mode: (string) mode in which to open the file optional

Return values

Returns (file) file object