Função SetEnvironmentVariableA (processenv.h)
Define o conteúdo da variável de ambiente especificada para o processo atual.
Sintaxe
BOOL SetEnvironmentVariableA(
[in] LPCSTR lpName,
[in, optional] LPCSTR lpValue
);
Parâmetros
[in] lpName
O nome da variável de ambiente. O sistema operacional criará a variável de ambiente se ela não existir e lpValue não for NULL.
[in, optional] lpValue
O conteúdo da variável de ambiente. O tamanho máximo de uma variável de ambiente definida pelo usuário é de 32.767 caracteres. Para obter mais informações, consulte variáveis de ambiente.
Windows Server 2003 e Windows XP: O tamanho total do bloco de ambiente para um processo não pode exceder 32.767 caracteres.
Se esse parâmetro for NULL, a variável será excluída do ambiente do processo atual.
Valor de retorno
Se a função for bem-sucedida, o valor retornado não será zero.
Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.
Observações
Essa função não tem efeito sobre as variáveis de ambiente do sistema ou as variáveis de ambiente de outros processos.
Exemplos
Para obter um exemplo, consulte Alterando variáveis de ambiente.
Nota
O cabeçalho processenv.h define SetEnvironmentVariable 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 |