Environ

concerns

The Environ function returns the string associated with an operating system environment variable.

 

Syntax

Environ(Element)

Return value

Type

Description

String

The value of the queried environment name

Parameter

Use

Name

Type

Passing

Description

Required

Element

String

ByVal

The environment value to be determined

The Element parameter passes either the name of an environment variable or a numeric expression according to the numeric order of the environment string in the environment string table.

If the specified name cannot be found in the environment string table, a zero string ("") is returned. Otherwise the text assigned to the specified environment string is returned. This is the text specified after the equal sign (=) in the environment string table for this environment variable.

Wenn ein numerischer Ausdruck angeben, wird die Zeichenfolge zurückgegeben, die an der entsprechenden numerischen Position in der Tabelle für Umgebungszeichenfolgen steht. In solch einem Fall gibt die Environ-Funktion den ganzen Text (einschließlich des übergebenen Parameters) zurück. Wird keine Umgebungszeichenfolge an der angegebenen Position, so wird eine Null-Zeichenfolge ("") zurückgeliefert.

 

Example:

 

MsgBox(Client.Environ("Path"))

 

This example determines the contents of the Path variable on the Windows system. The path variable deposits the access paths for finding files in the windows system.