_putenv_s、_wputenv_s

新しい環境変数を作成します。あるいは既存の環境変数を変更または削除します。 これらの関数は、「CRT のセキュリティ機能」に説明されているように、_putenv、_wputenv のセキュリティが強化されたバージョンです。

errno_t _putenv_s(
   const char *name,
   const char *value 
);
errno_t _wputenv_s(
   const wchar_t *name,
   const wchar_t *value
);

パラメーター

• name
  環境変数名。

• value
  環境変数の設定値。

戻り値

正常終了した場合は 0 を返し、失敗した場合はエラー コードを返します。

エラー条件

いずれかのエラー条件が発生すると、これらの関数は「パラメーターの検証」に説明されているように、無効なパラメーター ハンドラーを呼び出します。 実行の継続が許可された場合、これらの関数は EINVAL を返し、errno を EINVAL に設定します。

解説

_putenv_s 関数は、新しい環境変数を追加するか、既存の環境変数の値を変更します。 環境変数は、プロセスが実行される環境を定義します (たとえば、プログラムとリンクするライブラリの既定の検索パスなど)。 _wputenv_s 関数は、_putenv_s 関数のワイド文字バージョンです。_wputenv_s 関数の引数 envstring は、ワイド文字列です。

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

name は追加または変更する環境変数の名前であり、value は変数の値です。 name が既に環境に設定されている場合は、その値が value に置き換えられます。それ以外の場合は、新しい name 変数とその value が環境に追加されます。 value に空の文字列 ("") を指定すると、環境から変数を削除できます。

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

環境エントリは直接変更しないでください。代わりに、使用_putenv_sまたは_wputenv_sそれを変更します。 特に、_environ[] グローバル配列の要素を直接解放すると、無効なメモリ アドレスが指定される可能性があります。

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

必要条件

互換性の詳細については、「C ランタイム ライブラリ」の「互換性」を参照してください。

使用例

_putenv_s の使用例については、「getenv_s、_wgetenv_s」を参照してください。

同等の .NET Framework 関数

該当なし標準 C 関数を呼び出すには、PInvoke を使用します。詳細については、「プラットフォーム呼び出しの例」を参照してください。

参照

参照

プロセス制御と環境制御

getenv、_wgetenv

_searchenv、_wsearchenv