Nota: A função, método, objeto ou propriedade descrita neste tópico está desativada se o Serviço Microsoft Jet Expression estiver em execução no modo sandbox, o que impede a avaliação de expressões potencialmente inseguras. Para obter mais informações sobre o modo sandbox, procure "modo sandbox" na Ajuda.
Devolve a Cadeia associada a uma variável de ambiente do sistema operativo. Não disponível no Macintosh
Sintaxe
Environ( { envstring | number } )
A sintaxe da função Ambiente tem estes argumentos:
Argumento | Descrição |
|---|---|
|
envstring |
Opcional. Expressão de cadeia 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 ambiente na tabela environment-string. O argumento number pode ser qualquer expressão numérica, mas é arredondado para um número inteiro antes de ser avaliado. |
Observações
Se não for possível encontrar envstring na tabela environment-string, é devolvida uma cadeia de comprimento zero (""). Caso contrário, o Ambiente devolve o texto atribuído à envstring especificada; ou seja, o texto que segue o sinal de igual (=) na tabela environment-string para essa variável de ambiente.
Se especificar o número, é devolvida a cadeia que ocupa essa posição numérica na tabela environment-string. Neste caso, Environ devolve todo o texto, incluindo envstring. Se não existir uma cadeia de ambiente na posição especificada, o Ambiente devolve uma cadeia de comprimento zero.
Exemplo
Nota: Os exemplos seguintes demonstram a utilização desta função no módulo VBA (Visual Basic for Applications). Para obter mais informações sobre como trabalhar com o VBA, selecione Referência para Programadores na lista pendente junto a Procurar e introduza um ou mais termos na caixa de pesquisa.
Este exemplo utiliza a função Ambiente para fornecer o número de entrada e o comprimento da instrução PATH da tabela environment-string. 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