Difference between revisions of "Io.output"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[io]]<br/>
 +
 
=== Description ===
 
=== Description ===
<translate>When called with a file name, it opens the named file (in text mode), and sets its handle as the default output file. When called with a file handle, it simply sets this file handle as the default output file. When called without parameters, it returns the current default output file.  
+
When called with a file name, it opens the named file (in text mode), and sets its handle as the default output file.
  
 +
When called with a file handle, it simply sets this file handle as the default output file.
  
In case of errors this function raises the error, instead of returning an error code.</translate>
+
When called without parameters, it returns the current default output file.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(file) = io.output(file)
 
(file) = io.output(file)
</source>
+
</syntaxhighlight>
 +
 
 +
'''In case of errors this function raises the error, instead of returning an error code.'''
 +
 
 
=== Parameters ===
 
=== Parameters ===
'''file''': (file) <translate>file object to use as default output</translate> '''optional'''<br/>
+
'''file''': (file) file object to use as default output '''optional'''<br/>
 +
 
 
=== Return values ===
 
=== Return values ===
'''Returns''' (file) <translate>default output file object</translate><br/>
+
'''Returns''' (file) default output file object<br/>
 +
 
 +
{{Io}}

Latest revision as of 14:30, 13 July 2023

Available since: Gideros 2011.6
Class: io

Description

When called with a file name, it opens the named file (in text mode), and sets its handle as the default output file.

When called with a file handle, it simply sets this file handle as the default output file.

When called without parameters, it returns the current default output file.

(file) = io.output(file)
In case of errors this function raises the error, instead of returning an error code.

Parameters

file: (file) file object to use as default output optional

Return values

Returns (file) default output file object