_putenv_s, _wputenv_s, _tputenv_s

Cria, modifica ou remove as variáveis de ambiente. Essas funções são versões do , _wputenvque têm aprimoramentos de_putenv segurança, conforme descrito em Recursos de segurança no CRT.

Para _tputenv_s, consulte Mapeamentos de função de texto genérico.

Sintaxe

errno_t _putenv_s(
   const char *varname,
   const char *value_string
);
errno_t _wputenv_s(
   const wchar_t *varname,
   const wchar_t *value_string
);

Parâmetros

varname
O nome da variável de ambiente.

value_string
O valor a ser definido para a variável de ambiente.

Valor retornado

Retorna 0 se for bem-sucedido ou um código de erro.

Condições de erro

Se ocorrer uma das condições de erro, essas funções invocarão um manipulador de parâmetro inválido, conforme descrito em Validação de parâmetro. Se a execução puder continuar, essas funções retornarão EINVAL e definirão errno para EINVAL.

Comentários

A função _putenv_s adiciona novas variáveis de ambiente ou modifica os valores de variáveis de ambiente existentes. Variáveis de ambiente definem o ambiente no qual um processo é executado (por exemplo, o caminho de pesquisa padrão para bibliotecas a ser vinculado a um programa). A função _wputenv_s é uma versão de caractere largo da função _putenv_s; o argumento envstring para _wputenv_s é uma cadeia de caracteres larga.

Por padrão, o estado global dessa função tem como escopo o aplicativo. Para alterar esse comportamento, confira Estado global no CRT.

Mapeamentos de funções de texto genérico

A função na coluna é mapeada tchar.h para a função nas outras colunas, dependendo do conjunto de caracteres definido em tempo de compilação.

varname é o nome da variável de ambiente a ser adicionada ou modificada e value_string é o valor da variável. Se varname já fizer parte do ambiente, seu valor será substituído por value_string; caso contrário, a nova variável varname e seu value_string são adicionadas ao ambiente. Você pode remover uma variável do ambiente especificando uma cadeia de caracteres vazia (isto é, "") para value_string.

_putenv_s e _wputenv_s afetam apenas o ambiente que é local para o processo atual; você não pode usá-los para modificar o ambiente de nível de comando. Essas funções operam somente nas estruturas de dados que são acessíveis para a biblioteca em tempo de execução e não no “segmento” de ambiente que o sistema operacional cria para um processo. Quando o processo atual termina, o ambiente será revertido para o nível do processo de chamada, que, na maioria dos casos, é o nível do sistema operacional. No entanto, o ambiente modificado pode ser passado para novos processos criados por _spawn, _exec ou system e esses novos processos obtém os novos itens que são adicionados por _putenv_s e _wputenv_s.

Não altere uma entrada de ambiente diretamente. Em vez disso, use _putenv_s ou _wputenv_s para alterá-la. Em especial, liberar elementos da matriz global _environ[] diretamente pode fazer com que a memória inválida seja resolvida.

getenv e _putenv_s usam a variável global _environ para acessar a tabela de ambiente; _wgetenv e _wputenv_s usam _wenviron. _putenv_s e _wputenv_s podem alterar o valor de _environ e _wenviron, invalidando, portanto, o argumento envp para main e o argumento _wenvp para wmain. Portanto, é mais seguro usar _environ ou _wenviron para acessar as informações de ambiente. Para obter mais informações sobre a relação de _putenv_s e _wputenv_s com as variáveis globais, confira _environ,_wenviron.

Requisitos

Para obter informações sobre compatibilidade, consulte Compatibilidade.

Exemplo

Para ver uma amostra que mostra como usar _putenv_s, confira getenv_s, _wgetenv_s.

Confira também

Controle de processo e ambiente
getenv, _wgetenv
_searchenv, _wsearchenv