Core Function EnvGet

From Sputnik Wiki
Jump to: navigation, search
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

Without Tag:

Success: The value as a string

Failure: null (or empty string if the tag didn't exist)

With Tag:

Success: Array of tags and values

Failure: null (or empty array if there was no tags)

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");
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox