Interaction.Environ, méthode (Int32)

Article
08/21/2007

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

Espace de noms : Microsoft.VisualBasic
Assembly : Microsoft.VisualBasic (dans microsoft.visualbasic.dll)

Syntaxe

'Déclaration
Public Shared Function Environ ( _
    Expression As Integer _
) As String
'Utilisation
Dim Expression As Integer
Dim returnValue As String

returnValue = Interaction.Environ(Expression)

public static string Environ (
    int Expression
)

public:
static String^ Environ (
    int Expression
)

public static String Environ (
    int Expression
)

public static function Environ (
    Expression : int
) : String

Paramètres

Expression
Obligatoire. 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.

Valeur de retour

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

Notes

Pour plus d'informations, consultez la rubrique Visual Basic Environ, fonction.

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 de l'argument Expression est introuvable dans la table de chaînes d'environnement, une chaîne de longueur nulle ("") est retournée.

Si l'argument 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.

Remarque 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

Plates-formes

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile pour Pocket PC, Windows Mobile pour Smartphone, Windows Server 2003, Windows XP Édition Media Center, Windows XP Professionnel Édition x64, Windows XP SP2, Windows XP Starter Edition

Le .NET Framework ne prend pas en charge toutes les versions de chaque plate-forme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise.

Informations de version

.NET Framework

Prise en charge dans : 2.0, 1.1, 1.0

Voir aussi

Référence

Interaction, classe
Membres Interaction
Microsoft.VisualBasic, espace de noms
ArgumentException

Autres ressources

Environ, fonction
Membres de la bibliothèque runtime Visual Basic

Partager via