Difference between revisions of "Io.type"
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 === | ||
| − | + | Checks whether '''obj''' is a valid file handle. | |
| − | < | + | <syntaxhighlight lang="lua"> |
(string) = io.type(obj) | (string) = io.type(obj) | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
| + | Returns the string: | ||
| + | *'''"file"''' if obj is an open file handle | ||
| + | *'''"closed file"''' if obj is a closed file handle | ||
| + | *'''nil''' if obj is not a file handle | ||
| + | |||
=== Parameters === | === Parameters === | ||
| − | '''obj''': (any) | + | '''obj''': (any) object to test<br/> |
| + | |||
=== Return values === | === Return values === | ||
| − | '''Returns''' (string) | + | '''Returns''' (string) string representing the state of the object or nil if not file handler<br/> |
| + | |||
| + | {{Io}} | ||
Latest revision as of 14:31, 13 July 2023
Available since: Gideros 2011.6
Class: io
Description
Checks whether obj is a valid file handle.
(string) = io.type(obj)
Returns the string:
- "file" if obj is an open file handle
- "closed file" if obj is a closed file handle
- nil if obj is not a file handle
Parameters
obj: (any) object to test
Return values
Returns (string) string representing the state of the object or nil if not file handler
