_putenv, _wputenv

Cria, modifica ou remove as variáveis de ambiente. Versões mais seguras dessas funções estão disponíveis; consulte _putenv_s , _wputenv_s.

Importante

Esta API não pode ser usada em aplicativos executados no Windows Runtime. Para obter mais informações, confira Funções do CRT sem suporte em aplicativos da Plataforma Universal do Windows.

Sintaxe

int _putenv(
   const char *envstring
);
int _wputenv(
   const wchar_t *envstring
);

Parâmetros

envstring
Definição de cadeia de caracteres de ambiente.

Valor Retornado

Retorne 0 se for bem-sucedido ou-1 no caso de um erro.

Comentários

A função _putenv 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 é uma versão de caractere largo da função _putenv; o argumento envstring para _wputenv é uma cadeia de caracteres larga.

Por padrão, o estado global dessa função tem como escopo o aplicativo. Para alterar isso, consulte estado global no CRT.

Mapeamentos da rotina de texto genérico

Tchar.h rotina _UNICODE and _MBCS Não definido _MBCS definido _UNICODE definido
_tputenv _putenv _putenv _wputenv

O argumento envstring deve ser um ponteiro para uma cadeia de caracteres no formato varname=value_string, em que 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 valor value_string serão adicionados ao ambiente. Você pode remover uma variável do ambiente especificando um vazio value_string , ou em outras palavras, especificando somente varname =.

_putenv e _wputenv afetam apenas o ambiente local para o processo atual; você não pode usá-los para modificar o ambiente de nível de comando. Isso é, 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 criado para um processo pelo sistema operacional. Quando o processo atual termina, o ambiente é 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 e _wputenv.

Não altere uma entrada de ambiente diretamente: em vez disso, use _putenv ou _wputenv 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 usam a variável global _environ para acessar a tabela de ambiente; _wgetenv e _wputenv usam _wenviron. _putenv e _wputenv pode alterar o valor de _environ e _wenviron , invalidando, portanto, o _envp argumento para main e o _wenvp argumento para wmain . Portanto, é mais seguro usar _environ ou _wenviron acessar as informações do ambiente. Para obter mais informações sobre a relação de _putenv e _wputenv com as variáveis globais, consulte _environ , _wenviron.

Observação

As famílias de funções _putenv e _getenv não são thread-safe. _getenv poderia retornar um ponteiro de cadeia de caracteres enquanto _putenv está modificando a cadeia de caracteres, causando falhas aleatórias. As chamadas para essas funções devem estar sincronizadas.

Requisitos

Rotina Cabeçalho necessário
_putenv <stdlib.h>
_wputenv <stdlib.h> ou <wchar.h>

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

Exemplo

Para obter um exemplo de como usar _putenv o, consulte getenv , _wgetenv.

Confira também

Controle de processo e ambiente
getenv, _wgetenv
_searchenv, _wsearchenv