Função Environ

Artigo
08/25/2010

Retorna a sequência de caracteres associada com uma variável de ambiente do sistema operacional.

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

Parâmetros

Expression
Obrigatório.Expressão que avalia uma sequência de caracteres que contém o nome de uma variável de ambiente, ou um número inteiro correspondente a ordem numérica de uma sequência de caracteres de ambiente na tabela de sequência de caracteres de ambiente.

Exceções

Tipo de exceção	Número de erro	Condição
ArgumentException	5	Expression está faltando.

Ver a coluna " número de erro " se você estiver atualizando aplicativos Visual Basic 6.0 que usam manipulação de erros não estruturada.(Você pode comparar o número do erro com a Propriedade do Número (Erro de objeto).) Entretanto, quando for possivel, você pode considerar substituir tal controle de erro por Visão Geral sobre a Manipulação Estruturada de Exceções para o Visual Basic.

Comentários

Se Expression contém uma sequência de caracteres, a função Environ retornará o texto atribuído à sequência de caracteres de ambiente especificada — ou seja, o texto após o sinal de igualdade (=) na tabela que variável de ambiente para aquela variável de ambiente.Se a sequência de caracteres no Expression não puder ser encontrada na tabela de sequência de caracteres de ambiente, uma sequência de caracteres vazia (" ") é retornada.

Se Expression contiver um número inteiro, a sequência de caracteres que ocupa essa posição numérica na tabela de sequência de caracteres de ambiente é retornada.Nesse caso, Environ retornará todo o texto, incluindo o nome da variável de ambiente.Se não houver nenhuma sequência de caracteres de ambiente na posição especificada, Environ retornará uma sequência de caracteres vazia.

Observação de segurança:
O Environ função requer permissão de ambiente, 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 a código .

Exemplo

Este exemplo usa a função Environ para fornecer o número de entrada e o comprimento da instrução PATH da tabela de sequência 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

Anotações Developer Dispositivo Inteligente

Não há suporte para esta função.

Requisitos

Namespace: Microsoft.VisualBasic

**Módulo:**Interaction

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

Consulte também

Referência

Membros em tempo de execução da biblioteca do Visual Basic

ArgumentException

Compartilhar via