Interaction.Environ Méthode

Définition

Espace de noms:
Microsoft.VisualBasic
Assembly:
Microsoft.VisualBasic.dll

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

Surcharges

Nom Description
Environ(String)

Retourne la chaîne associée à une variable d’environnement du système d’exploitation.
Environ(Int32)

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

Environ(String)

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

public:
 static System::String ^ Environ(System::String ^ Expression);
public static string Environ(string Expression);
static member Environ : string -> string
Public Function Environ (Expression As String) As String

Paramètres

Expression
String

Required. Expression qui évalue une chaîne contenant le nom d’une variable d’environnement ou un entier correspondant à l’ordre numérique d’une chaîne d’environnement dans la table de chaînes d’environnement.

Retours

String

Chaîne associée à une variable d’environnement du système d’exploitation.

Exceptions

ArgumentException

Expression est manquant.

Exemples

Cet exemple utilise la Environ fonction pour fournir le numéro d’entrée et la longueur de l’instruction à partir de la PATH 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

Remarques

Si Expression elle contient une chaîne, la Environ fonction retourne le texte affecté à la chaîne d’environnement spécifiée, autrement dit, le texte suivant le signe égal (=) dans la table de chaînes d’environnement pour cette variable d’environnement. Si la chaîne dans laquelle Expression la chaîne est introuvable dans la table de chaînes d’environnement, une chaîne de longueur nulle («  ») est retournée.

Si Expression elle contient un entier, la chaîne occupant cette position numérique dans la table de chaînes d’environnement est retournée. Dans ce cas, Environ retourne tout le texte, y compris le nom de la variable d’environnement. S’il n’existe aucune chaîne d’environnement à la position spécifiée, Environ retourne une chaîne de longueur nulle.

Important

La Environ fonction nécessite une autorisation d’environnement, ce qui peut affecter son exécution dans des situations de confiance partielle. Pour plus d’informations, consultez SecurityPermission et autorisations d’accès au code.

Voir aussi

S’applique à

Environ(Int32)

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

public:
 static System::String ^ Environ(int Expression);
public static string Environ(int Expression);
static member Environ : int -> string
Public Function Environ (Expression As Integer) As String

Paramètres

Expression
Int32

Required. Expression qui évalue une chaîne contenant le nom d’une variable d’environnement ou un entier correspondant à l’ordre numérique d’une chaîne d’environnement dans la table de chaînes d’environnement.

Retours

String

Chaîne associée à une variable d’environnement du système d’exploitation.

Exceptions

ArgumentException

Expression est manquant.

Exemples

Cet exemple utilise la Environ fonction pour fournir le numéro d’entrée et la longueur de l’instruction à partir de la PATH 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

Remarques

Si Expression elle contient une chaîne, la Environ fonction retourne le texte affecté à la chaîne d’environnement spécifiée, autrement dit, le texte suivant le signe égal (=) dans la table de chaînes d’environnement pour cette variable d’environnement. Si la chaîne dans laquelle Expression la chaîne est introuvable dans la table de chaînes d’environnement, une chaîne de longueur nulle («  ») est retournée.

Si Expression elle contient un entier, la chaîne occupant cette position numérique dans la table de chaînes d’environnement est retournée. Dans ce cas, Environ retourne tout le texte, y compris le nom de la variable d’environnement. S’il n’existe aucune chaîne d’environnement à la position spécifiée, Environ retourne une chaîne de longueur nulle.

Important

La Environ fonction nécessite une autorisation d’environnement, ce qui peut affecter son exécution dans des situations de confiance partielle. Pour plus d’informations, consultez SecurityPermission et autorisations d’accès au code.

Voir aussi

S’applique à