Share via

Função SetEnvironmentVariable (winbase.h)

  • Artigo

Define o conteúdo da variável de ambiente especificada para o processo atual.

Sintaxe

BOOL SetEnvironmentVariable(
  [in]           LPCTSTR lpName,
  [in, optional] LPCTSTR 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 de um processo pode não exceder 32.767 caracteres.

Se esse parâmetro for NULL, a variável será excluída do ambiente do processo atual.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

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.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP [aplicativos da área de trabalho | aplicativos UWP]
Servidor mínimo com suporte Windows Server 2003 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho winbase.h (inclua Windows.h no Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

Variáveis de ambiente

Getenvironmentvariable