Interaction.Environ Método

Definição

Namespace:
Microsoft.VisualBasic
Assembly:
Microsoft.VisualBasic.dll

Retorna a cadeia de caracteres associada a uma variável de ambiente do sistema operacional.

Sobrecargas

Nome Description
Environ(String)

Retorna a cadeia de caracteres associada a uma variável de ambiente do sistema operacional.
Environ(Int32)

Retorna a cadeia de caracteres associada a uma variável de ambiente do sistema operacional.

Environ(String)

Retorna a cadeia de caracteres associada a uma variável de ambiente do sistema operacional.

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

Parâmetros

Expression
String

Required. Expressão que avalia uma cadeia de caracteres que contém o nome de uma variável de ambiente ou um inteiro correspondente à ordem numérica de uma cadeia de caracteres de ambiente na tabela de cadeia de caracteres de ambiente.

Retornos

String

A cadeia de caracteres associada a uma variável de ambiente do sistema operacional.

Exceções

ArgumentException

Expression está em falta.

Exemplos

Este exemplo usa a Environ função para fornecer o número de entrada e o PATH comprimento da instrução da tabela de cadeia de caracteres de ambiente.

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

Comentários

Se Expression contiver uma cadeia de caracteres, a Environ função retornará o texto atribuído à cadeia de caracteres de ambiente especificada , ou seja, o texto que segue o sinal de igual (=) na tabela de cadeia de caracteres de ambiente para essa variável de ambiente. Se a cadeia de caracteres não Expression puder ser encontrada na tabela de cadeia de caracteres de ambiente, uma cadeia de caracteres de comprimento zero ("") será retornada.

Se Expression contiver um inteiro, a cadeia de caracteres que ocupa essa posição numérica na tabela de cadeia de caracteres de ambiente será retornada. Nesse caso, Environ retorna todo o texto, incluindo o nome da variável de ambiente. Se não houver nenhuma cadeia de caracteres de ambiente na posição especificada, Environ retornará uma cadeia de caracteres de comprimento zero.

Importante

A Environ função requer permissão de ambiente, o que pode afetar sua execução em situações de confiança parcial. Para obter mais informações, consulte SecurityPermission e permissões de acesso ao código.

Confira também

Aplica-se a

Environ(Int32)

Retorna a cadeia de caracteres associada a uma variável de ambiente do sistema operacional.

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

Parâmetros

Expression
Int32

Required. Expressão que avalia uma cadeia de caracteres que contém o nome de uma variável de ambiente ou um inteiro correspondente à ordem numérica de uma cadeia de caracteres de ambiente na tabela de cadeia de caracteres de ambiente.

Retornos

String

A cadeia de caracteres associada a uma variável de ambiente do sistema operacional.

Exceções

ArgumentException

Expression está em falta.

Exemplos

Este exemplo usa a Environ função para fornecer o número de entrada e o PATH comprimento da instrução da tabela de cadeia de caracteres de ambiente.

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

Comentários

Se Expression contiver uma cadeia de caracteres, a Environ função retornará o texto atribuído à cadeia de caracteres de ambiente especificada , ou seja, o texto que segue o sinal de igual (=) na tabela de cadeia de caracteres de ambiente para essa variável de ambiente. Se a cadeia de caracteres não Expression puder ser encontrada na tabela de cadeia de caracteres de ambiente, uma cadeia de caracteres de comprimento zero ("") será retornada.

Se Expression contiver um inteiro, a cadeia de caracteres que ocupa essa posição numérica na tabela de cadeia de caracteres de ambiente será retornada. Nesse caso, Environ retorna todo o texto, incluindo o nome da variável de ambiente. Se não houver nenhuma cadeia de caracteres de ambiente na posição especificada, Environ retornará uma cadeia de caracteres de comprimento zero.

Importante

A Environ função requer permissão de ambiente, o que pode afetar sua execução em situações de confiança parcial. Para obter mais informações, consulte SecurityPermission e permissões de acesso ao código.

Confira também

Aplica-se a