SetEnvironmentVariableA 関数 (processenv.h)

現在のプロセスの指定した環境変数の内容を設定します。

構文

BOOL SetEnvironmentVariableA(
  [in]           LPCSTR lpName,
  [in, optional] LPCSTR lpValue
);

パラメーター

[in] lpName

環境変数の名前。 オペレーティング システムは、環境変数が存在せず、lpValue NULL でない場合に作成します。

[in, optional] lpValue

環境変数の内容。 ユーザー定義環境変数の最大サイズは 32,767 文字です。 詳細については、「環境変数の」を参照してください。

Windows Server 2003 および Windows XP: プロセスの環境ブロックの合計サイズは、32,767 文字を超えない場合があります。

このパラメーターが NULL の場合、変数は現在のプロセスの環境から削除されます。

戻り値

関数が成功した場合、戻り値は 0 以外です。

関数が失敗した場合、戻り値は 0 です。 拡張エラー情報を取得するには、GetLastError呼び出します。

備考

この関数は、システム環境変数や他のプロセスの環境変数には影響しません。

例

例については、「環境変数の変更参照してください。

手記

processenv.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetEnvironmentVariable を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows XP [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー	Windows Server 2003 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の	ウィンドウズ
ヘッダー	processenv.h (Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008 Windows Server 2008 R2 の Windows.h を含む)
ライブラリ	Kernel32.lib
DLL	Kernel32.dll

関連項目

環境変数の

GetEnvironmentVariable の