Difference between revisions of "Io.open"
From GiderosMobile
(redone) |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | < | + | '''Available since:''' Gideros 2011.6<br/> |
| + | '''Class:''' [[io]]<br/> | ||
| − | + | === Description === | |
| − | < | + | This function opens a file in the specified mode. The function returns a new file handle, or nil plus an error message. |
| − | + | <source lang="lua"> | |
| − | < | + | (file) = io.open(filename, mode) |
| + | </source> | ||
| − | |||
| − | |||
| − | |||
| − | The mode string can be any of the following: | + | The '''mode''' string can be any of the following: |
| − | + | *"r": read mode (the default) | |
| − | + | *"w": write mode | |
| − | "r": read mode (the default) | + | *"a": append mode |
| − | + | *"r+": update mode, all previous data is preserved | |
| − | "w": write mode | + | *"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 | |
| − | "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. | + | This string is exactly what is used in the standard C function fopen. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | === | + | === Parameters === |
| − | '''filename''': (string) | + | '''filename''': (string) filename to open<br/> |
| − | '''mode''': (string) | + | '''mode''': (string) mode in which to open the file '''optional''' (default = "r")<br/> |
| − | === | + | === Return values === |
| − | ''' | + | '''Returns''' (file) file object<br/> |
{{Io}} | {{Io}} | ||
Revision as of 07:04, 7 December 2020
Available since: Gideros 2011.6
Class: io
Description
This function opens a file in the specified mode. The function returns a new file handle, or nil plus an error message.
(file) = io.open(filename, mode)
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.
Parameters
filename: (string) filename to open
mode: (string) mode in which to open the file optional (default = "r")
Return values
Returns (file) file object
