_putenv、_wputenv

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

環境変数を作成、変更、または削除します。これらの関数のセキュリティを強化したバージョンについては、「_putenv_s、_wputenv_s」を参照してください。

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

パラメータ

envstring
環境文字列の定義。

戻り値

正常に終了した場合は 0、エラーが発生した場合は –1 を返します。

解説

_putenv 関数は、新しい環境変数を追加するか、既存の環境変数の値を変更します。環境変数は、プロセスが実行される環境を定義します (たとえば、プログラムとリンクするライブラリの既定の検索パスなど)。ワイド文字を扱う場合は、_putenv ではなく _wputenv を使用します。この場合、_wputenv の envstring 引数には、ワイド文字列を指定します。

汎用テキストルーチンのマップ

Tchar.h のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tputenv	_putenv	_putenv	_wputenv

envstring 引数には、varname=string の形式で文字列へのポインタを指定する必要があります。varname は追加または変更する環境変数の名前、string は変数の値になります。varname が既に環境に設定されている場合は、その値が string に置き換えられます。それ以外の場合は、新しい varname 変数とその string 値が環境に追加されます。環境変数を削除するには、string に空の文字列を指定します。つまり、varname= だけを指定します。

_putenv 関数と _wputenv 関数は、現在のプロセスのローカル環境にしか影響しません。これらの関数を使用して、コマンドレベルの環境は変更できません。つまり、これらの関数で変更できるのは、ランタイムライブラリにアクセスできるデータ構造だけであり、オペレーティングシステムによってプロセス用に作成される環境セグメントは変更しません。現在実行中のプロセスが終了すると、呼び出しプロセス (ほとんどの場合はオペレーティングシステムレベル) の環境が復元されます。ただし、変更された環境は、_spawn、_exec、または system の各関数で作成された新しいプロセスに渡すことができます。新しいプロセスは、_putenv 関数および _wputenv 関数によって追加された新しい項目を取得します。

環境エントリは直接変更せず、_putenv 関数または _wputenv 関数を使用して変更します。特に、_environ[] グローバル配列の要素を直接解放すると、無効なメモリアドレスが指定される可能性があります。

getenv 関数および _putenv 関数は、_environ グローバル変数を使用して環境テーブルにアクセスします。したがって、_wgetenv 関数および _wputenv 関数は _wenviron を使用します。_putenv 関数および _wputenv 関数は、_environ および _wenviron の値を変更する場合があるため、main の _envp 引数、および wmain の wenvp 引数は無効になります。したがって、環境情報にアクセスする場合は、_environ または _wenviron を使用する方が安全です。_putenv 関数および _wputenv 関数とグローバル変数の関係については、_environ、_wenviron の説明を参照してください。

メモ :
_putenv 系関数と _getenv 系関数はスレッドセーフではありません。_putenv が文字列を変更している間に _getenv が文字列ポインタを返すことがあり、これはランダムエラーの原因になります。これらの関数の呼び出しが同期されていることを確認する必要があります。