Environ-Funktion

  • Artikel

Aktualisiert: November 2007

Gibt die zu einer Betriebssystem-Umgebungsvariablen gehörige Zeichenfolge zurück.

Overloads Function Environ(ByVal Expression As Integer) As String
' -or-
Overloads Function Environ(ByVal Expression As String) As String

Parameter

  • Expression
    Erforderlich. Ausdruck, mit dem entweder eine Zeichenfolge ausgewertet wird, die den Namen einer Umgebungsvariablen enthält, oder eine ganze Zahl, die der numerischen Position einer Umgebungszeichenfolge in der Umgebungszeichenfolgentabelle entspricht.

Ausnahmen

Ausnahmetyp

Fehlernummer

Bedingung

ArgumentException

5

Expression fehlt.

Beachten Sie die Spalte "Fehlernummer", wenn Sie Visual Basic 6.0-Anwendungen aktualisieren, die die unstrukturierte Fehlerbehandlung verwenden. (Sie können die Fehlernummer mit der Number-Eigenschaft (Err-Objekt) vergleichen.) Wenn möglich, sollten Sie jedoch erwägen, eine solche Fehlersteuerung durch eine Übersicht über die strukturierte Ausnahmebehandlung für Visual Basic zu ersetzen.

Hinweise

Wenn Expression eine Zeichenfolge enthält, gibt die Environ-Funktion den der angegebenen Umgebungszeichenfolge zugewiesenen Text zurück; d. h. den Text, der in der Umgebungszeichenfolgentabelle für die betreffende Umgebungsvariable auf das Gleichheitszeichen (=) folgt. Wenn die Zeichenfolge in Expression in der Umgebungszeichenfolgentabelle nicht ermittelt werden kann, wird eine Zeichenfolge mit der Länge 0 (null, "") zurückgegeben.

Wenn Expression eine ganze Zahl enthält, wird die Zeichenfolge auf der entsprechenden numerischen Position in der Umgebungszeichenfolgentabelle zurückgegeben. In diesem Fall gibt Environ den gesamten Text zurück, einschließlich des Namens der Umgebungsvariablen. Wenn sich an der angegebenen Position keine Umgebungszeichenfolge befindet, gibt Environ eine Zeichenfolge mit Nulllänge zurück.

Sicherheitshinweis:

Die Environ-Funktion erfordert eine Umgebungsberechtigung. Dies kann sich auf ihre Ausführung in teilweise vertrauenswürdigen Kontexten auswirken. Weitere Informationen finden Sie unter SecurityPermission und Codezugriffsberechtigungen.

Beispiel

In diesem Beispiel wird mit der Environ-Funktion die Eintragsnummer und Länge der PATH-Anweisung aus der Umgebungszeichenfolgentabelle angegeben.

Sub tenv()
   Dim envString As String
   Dim found As Boolean = False
   Dim index As Integer = 1
   Dim pathLength As Integer
   Dim message As String

   envString = Environ(index)
   While Not found And (envString <> "")
      If (envString.Substring(0, 5) = "Path=") Then
         found = True
      Else
         index += 1
         envString = Environ(index) 
      End If
   End While

   If found Then
      pathLength = Environ("PATH").Length
      message = "PATH entry = " & index & " and length = " & pathLength
   Else
      message = "No PATH environment variable exists."
   End If

   MsgBox(message)
End Sub

Hinweise für Entwickler intelligenter Geräte

Diese Funktion wird nicht unterstützt.

Anforderungen

Namespace:Microsoft.VisualBasic

**Modul:**Interaction

**Assembly:**Visual Basic Runtime Library (in Microsoft.VisualBasic.dll)

Siehe auch

Referenz

Member der Visual Basic-Laufzeitbibliothek

ArgumentException