Determina o conteúdo de uma variável de ambiente (environment) do sistema operacional em uso no Application Server.
Sintaxe
GetEnv( < cVarEnv > )
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Referência |
---|---|---|---|---|
cVarEnv | caractere | Indica o nome da variável de ambiente do sistema operacional. | X |
|
Retorno
Nome | Tipo | Descrição |
---|---|---|
cRet | caractere | Caso a variável de ambiente esteja definida, será retornada uma string correspondente ao conteúdo da variável. Caso a variável não esteja definida, é retornado uma string vazia ('') |
Observações
O comportamento da função GetEnv() é diretamente ligado ao sistema operacional em uso. Por exemplo, com o servidor de aplicação sendo executado em uma máquina Windows (R), o nome da variável de ambiente solicitada não é sensível a letras maiúsculas ou minúsculas (case insensitive), já em uma máquina Linux, maiúsculas e minúsculas são diferentes. Em Linux, se for criada a variável de ambiente "MySETEnv", você consegue recuperar seu conteúdo utilizando GetEnv("mysetenv"), mesmo que esteja em letras minúsculas. Já em Linux o nome da variável de ambiente para a função GetEnv() deve ser informado exatamente como foi criado.
Exemplos
User Function exemplo () conout( GetEnv('PATH') ) // Resultado: "C:\Windows\system32;C:\Windows;..." Return
Abrangência
Advanced Protheus 6.09 , Advanced Protheus 7.10 , Microsiga Protheus 8.11, Protheus 10 , TOTVS Application Server 10 , ByYou Application Server