Função Environ

Retorna a cadeia de caracteres associada a uma variável de ambiente do sistema operacional. Indisponível no Macintosh.

Sintaxe

Environ( { envstring | number } )

A sintaxe da função Environ tem estes argumentos nomeados:

Parte	Descrição
envstring	Opcional. Expressão de cadeia de caracteres como 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 argumentonumérico pode ser qualquer expressão numérica, mas é arredondado para um número inteiro antes de ser avaliado.

Comentários

Se não for possível encontrar envstring na tabela ambiente-cadeia de caracteres, uma cadeia de comprimento zero ("") retornará. Caso contrário, Environ retornará o texto atribuído ao envstring especificado; ou seja, o texto após o sinal de igual (=) na tabela ambiente-cadeia de caracteres dessa variável de ambiente.

Se você especificar number, a cadeia de caracteres que ocupa essa posição numérica na tabela ambiente-cadeia de caracteres retornará. Nesse caso, Environ retornará todo o texto, incluindo envstring. Se não houver uma cadeia de caracteres de ambiente na posição especificada, Environ retornará uma cadeia de caracteres de comprimento zero.

Exemplo

Este exemplo usa a função Environ para fornecer o número de entrada e a duração da instrução PATH da tabela ambiente-cadeia de caracteres. Indisponível no Macintosh.

Dim EnvString, Indx, Msg, PathLen    ' Declare variables.
Indx = 1    ' Initialize index to 1.
Do
    EnvString = Environ(Indx)    ' Get environment 
                ' variable.
    If Left(EnvString, 5) = "PATH=" Then    ' Check PATH entry.
        PathLen = Len(Environ("PATH"))    ' Get length.
        Msg = "PATH entry = " & Indx & " and length = " & PathLen
        Exit Do
    Else
        Indx = Indx + 1    ' Not PATH entry,
    End If    ' so increment.
Loop Until EnvString = ""
If PathLen > 0 Then
    MsgBox Msg    ' Display message.
Else
    MsgBox "No PATH environment variable exists."
End If

Confira também

• Funções (Visual Basic for Applications)

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.