Os.getenv: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
<languages />
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
'''Class:''' [[os]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/os|os]]<br/>
 
=== <translate>Description</translate> ===
=== Description ===
<translate>Returns the value of the process environment variable varname, or nil if the variable is not defined.</translate>
Returns the value of the process environment variable varname, or nil if the variable is not defined.
<source lang="lua">
<source lang="lua">
(any) = os.getenv(varname)
(any) = os.getenv(varname)
</source>
</source>
=== <translate>Parameters</translate> ===
 
'''varname''': (string) <translate>name of the variable</translate> <br/>
=== Parameters ===
=== <translate>Return values</translate> ===
'''varname''': (string) name of the variable<br/>
'''<translate>Returns</translate>''' (any) <translate>value of the variable</translate><br/>
 
=== Return values ===
'''Returns''' (any) value of the variable<br/>
 
=== Examples ===
<source lang="lua">
os.getenv("HOME") -- user folder on Mac & Linux
os.getenv("HOMEPATH") -- user folder on Windows
os.getenv("HOMEDRIVE") -- user drive on Windows
</source>


{{Os}}
{{Os}}

Revision as of 11:30, 29 June 2022

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