Environ, fonction

  • Article

Mise à jour : novembre 2007

Retourne la chaîne associée à une variable d'environnement de système d'exploitation.

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

Paramètres

  • Expression
    Requis. Expression qui évalue soit une chaîne contenant le nom d'une variable d'environnement, soit un entier correspondant à l'ordre numérique d'une chaîne d'environnement de la table de chaînes d'environnement.

Exceptions

Type d'exception

Numéro de l'erreur

Condition

ArgumentException

5

Expression est manquante.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion non structurée des erreurs. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreurs par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Si Expression contient une chaîne, la fonction Environ retourne le texte assigné à la chaîne d'environnement spécifiée, c'est-à-dire le texte qui suit le signe égal (=) dans la table de chaînes d'environnement pour cette variable d'environnement. Si la chaîne dans Expression est introuvable dans la table de chaînes d'environnement, une chaîne de longueur nulle ("") est retournée.

Si Expression contient un entier, la chaîne qui occupe cette position numérique dans la table de chaînes d'environnement est retournée. Dans ce cas, la fonction Environ retourne la totalité du texte, y compris le nom de la variable d'environnement. Si aucune chaîne d'environnement ne se trouve dans la position spécifiée, la fonction Environ retourne une chaîne de longueur nulle.

Note de sécurité :

La fonction Environ nécessite une permission d'environnement, qui peut affecter son exécution dans les situations d'un niveau de confiance partiel. Pour plus d'informations, consultez SecurityPermission et Autorisations d'accès du code.

Exemple

Cet exemple utilise la fonction Environ pour fournir le numéro d'entrée et la longueur de l'instruction PATH à partir de la table de chaînes d'environnement.

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

Notes du développeur sur Smart Device

Cette fonction n'est pas prise en charge.

Configuration requise

Espace de noms :Microsoft.VisualBasic

**Module :**Interaction

**Assembly :**bibliothèque Visual Basic Runtime (dans Microsoft.VisualBasic.dll)

Voir aussi

Référence

Membres de la bibliothèque runtime Visual Basic

ArgumentException