Função GetEnvironmentStringsW (processenv.h)
Recupera as variáveis de ambiente para o processo atual.
Sintaxe
LPWCH GetEnvironmentStringsW();
Valor de retorno
Se a função for bem-sucedida, o valor retornado será um ponteiro para o bloco de ambiente do processo atual.
Se a função falhar, o valor retornado será NULL.
Observações
A função GetEnvironmentStrings retorna um ponteiro para um bloco de memória que contém as variáveis de ambiente do processo de chamada (tanto o sistema quanto as variáveis de ambiente do usuário). Cada bloco de ambiente contém as variáveis de ambiente no seguinte formato:
Var1=Value1\0
Var2=Value2\0
Var3=Value3\0
...
=
ValueN do VarN\0\0
O nome de uma variável de ambiente não pode incluir um sinal de igual (=).
Trate essa memória como somente leitura; não modifique-o diretamente. Para adicionar ou alterar uma variável de ambiente, use as funções GetEnvironmentVariable e SetEnvironmentVariable.
Quando o bloco retornado por GetEnvironmentStrings não for mais necessário, ele deverá ser liberado chamando a função FreeEnvironmentStrings.
Observe que a versão ANSI dessa função, GetEnvironmentStringsA, retorna caracteres OEM.
Exemplos
Para obter um exemplo, consulte Alterando variáveis de ambiente.
Nota
O cabeçalho processenv.h define GetEnvironmentStrings como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.
Requisitos
| Requisito | Valor |
|---|---|
| de cliente com suporte mínimo | Windows XP [aplicativos da área de trabalho | Aplicativos UWP] |
| servidor com suporte mínimo | Windows Server 2003 [aplicativos da área de trabalho | Aplicativos UWP] |
| da Plataforma de Destino |
Windows |
| cabeçalho | processenv.h (inclua Windows.h no Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2) |
| biblioteca | Kernel32.lib |
| de DLL |
Kernel32.dll |
Consulte também
SetEnvironmentVariable