Die Environ-Funktion gibt die mit einer Betriebssystem-Umgebungsvariablen verbundene Zeichenfolge zurück.
Syntax | |||||
Environ(Element) | |||||
Rückgabewert | |||||
Typ |
Beschreibung | ||||
String |
Der Wert der abgefragten Environment-Namens | ||||
Parameter | |||||
Verwendung |
Name |
Typ |
Übergabe |
Beschreibung | |
Erforderlich |
Element |
String |
ByVal |
Der zu ermittelnde Environment-Wert | |
Mit dem Parameter Element wird entweder der Name einer Umgebungsvariablen oder ein numerischer Ausdruck entsprechend der numerischen Reihenfolge der Umgebungszeichenfolge in der Tabelle für Umgebungszeichenfolgen übergeben.
Kann der angegebene Name in der Tabelle für Umgebungszeichenfolgen nicht gefunden werden, so wird eine Null-Zeichenfolge ("") zurückgegeben. Ansonsten wird der Text zurückgegeben, der der angegebenen Umgebungszeichenfolge zugewiesen wurde. Dieses ist der Text, der nach dem Gleichheitszeichen (=) in der Tabelle für die Umgebungszeichenfolgen für diese Umgebungsvariable angegeben ist.
Wenn ein numerischer Ausdruck angegeben, 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.
Beispiel:
MsgBox(Client.Environ("Path"))
Dieses Beispiel ermittelt den Inhalt der Path-Variable des Windows-Systems. In der Path-Variablen werden die Zugriffspfade zum Suchen von Dateien im Windows-System hinterlegt.