Observação
A função, método, objeto ou propriedade descrita neste tópico será desabilitada se o Serviço de Expressão de Jato da Microsoft estiver em execução no modo de área restrita, o que impede a avaliação de expressões potencialmente inseguras. Para obter mais informações sobre o modo de área restrita, procure por "modo de área restrita" na Ajuda.
Retorna a Cadeia de Caracteres associada a uma variável de ambiente do sistema operacional. Não disponível no Macintosh
Sintaxe
Environ( { número de envstring | } )
A sintaxe da função Environ tem esses argumentos:
| Argumento | Descrição |
|---|---|
| envstring | Opcional. Expressão de cadeia de caracteres que contém o nome de uma variável de ambiente. |
| Número | Opcional. Expressão numérica correspondente à ordem numérica da cadeia de caracteres de ambiente na tabela de cadeia de caracteres de ambiente. O argumento numérico pode ser qualquer expressão numérica, mas é arredondado para um número inteiro antes de ser avaliado. |
Comentários
Se o envstring não puder ser encontrado na tabela de cadeia de caracteres do ambiente, uma cadeia de caracteres de comprimento zero (")será retornada. Caso contrário, Environ retornará o texto atribuído à envstring especificada; ou seja, o texto que segue o sinal igual (=) na tabela de cadeia de caracteres de ambiente para essa variável de ambiente.
Se você especificar o número, 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 envstring. Se não houver nenhuma cadeia de caracteres de ambiente na posição especificada, Environ retornará uma cadeia de caracteres de comprimento zero.
Exemplo
Observação
Exemplos a seguir demonstram o uso dessa função em um módulo VBA (Visual Basic for Applications). Para obter mais informações sobre como trabalhar com o VBA, selecione Referência do Desenvolvedor na lista suspensa ao lado de Pesquisar e insira um ou mais termos na caixa de pesquisa.
Este exemplo usa a função Environ para fornecer o número de entrada e o PATH comprimento da instrução da tabela de cadeia de caracteres de ambiente. Não está disponível no Macintosh.
Dim EnvString, Indx, Msg, PathLen ' Declare variables.
Indx = 1 ' Initialize index to 1.
Do
' Get environment variable.
EnvString = Environ(Indx)
' Check PATH entry.
If Left(EnvString, 5) = "PATH=" Then
' Get length.
PathLen = Len(Environ("PATH"))
Msg = "PATH entry = " & Indx & " and length = " _
& PathLen
Exit Do
Else
' Not PATH entry, so increment.
Indx = Indx + 1
End If
Loop Until EnvString = ""
If PathLen > 0 Then
' Display message.
MsgBox Msg
Else
MsgBox "No PATH environment variable exists."
End If