_putenv、_wputenv
環境変数を作成、変更、または削除します。 これらの関数のセキュリティを強化したバージョンについては、「_putenv_s、_wputenv_s」を参照してください。
重要
この API は、Windows ランタイムで実行するアプリケーションでは使用できません。詳細については、「/ZW でサポートされない CRT 関数」を参照してください。
int _putenv(
const char *envstring
);
int _wputenv(
const wchar_t *envstring
);
パラメーター
- envstring
環境文字列定義。
戻り値
成功の場合は 0 を返し、エラーの場合は –1 を返します。
解説
_putenv の関数は、新しい環境変数を追加したり、既存の環境変数の値を変更したりします。 環境変数は、プロセス (たとえば、プログラムにリンクされるライブラリの既定の検索パス) が実行される環境を定義します。 _wputenv 関数は、_putenv 関数のワイド文字バージョンです。_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 が文字列ポインターを返すことがあり、これはランダム エラーの原因になります。これらの関数の呼び出しが同期されていることを確認する必要があります。
必要条件
ルーチン |
必須ヘッダー |
|---|---|
_putenv |
<stdlib.h> |
_wputenv |
<stdlib.h> または <wchar.h> |
互換性の詳細については、「互換性」を参照してください。
使用例
_putenv 関数の使用例については、「getenv、_wgetenv」を参照してください。
同等の .NET Framework 関数
使用できません。標準 C 関数を呼び出すには、PInvoke を使用します。詳細については、「プラットフォーム呼び出しの例」を参照してください。