Os.getenv: Difference between revisions
From GiderosMobile
No edit summary |
m Text replacement - "</source>" to "</syntaxhighlight>" |
||
| (7 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:''' [[os]]<br/> | |||
=== Description === | === Description === | ||
Returns the value of the process environment variable varname, or nil if the variable is not defined. | Returns the value of the process environment variable varname, or nil if the variable is not defined. | ||
< | <syntaxhighlight lang="lua"> | ||
(any) = os.getenv(varname) | (any) = os.getenv(varname) | ||
</ | </syntaxhighlight> | ||
=== Parameters === | === Parameters === | ||
'''varname''': (string) name of the variable <br/> | '''varname''': (string) name of the variable<br/> | ||
=== Return values === | === Return values === | ||
'''Returns''' (any) value of the variable<br/> | '''Returns''' (any) value of the variable<br/> | ||
=== Examples === | |||
<syntaxhighlight lang="lua"> | |||
os.getenv("HOME") -- user folder on Mac & Linux | |||
os.getenv("HOMEPATH") -- user folder on Windows | |||
os.getenv("HOMEDRIVE") -- user drive on Windows | |||
</syntaxhighlight> | |||
{{Os}} | |||
Latest revision as of 13:31, 13 July 2023
Available since: Gideros 2011.6
Class: os
Description
Returns the value of the process environment variable varname, or nil if the variable is not defined.
(any) = os.getenv(varname)
Parameters
varname: (string) name of the variable
Return values
Returns (any) value of the variable
Examples
os.getenv("HOME") -- user folder on Mac & Linux
os.getenv("HOMEPATH") -- user folder on Windows
os.getenv("HOMEDRIVE") -- user drive on Windows