Core Function EnvGet
From Sputnik Wiki
(Difference between revisions)
(→Return Value) |
(→tag) |
||
| Line 11: | Line 11: | ||
==== tag ==== | ==== tag ==== | ||
| − | Name of the environment variable to get such as "TEMP" or "PATH". | + | Optional; Name of the environment variable to get such as "TEMP" or "PATH". |
| + | |||
| + | If no tag is given all tags and values will be returned as an array. | ||
=== Return Value === | === Return Value === | ||
Revision as of 12:53, 29 August 2013
EnvGet( <tag> )
Contents |
Description
Get the value of an environment variable.
Parameters
tag
Optional; Name of the environment variable to get such as "TEMP" or "PATH".
If no tag is given all tags and values will be returned as an array.
Return Value
Success:
Remarks
A environment variable set in this way will only be accessible to programs that Sputnik spawns (Run, RunWait).
Once Sputnik closes, the variables will cease to exist.
Example
$var = EnvGet("PATH"); MsgBox("Path variable is: $var");