SetEnvironmentVariable 関数 (winbase.h)

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

構文

BOOL SetEnvironmentVariable(
  [in]           LPCTSTR lpName,
  [in, optional] LPCTSTR lpValue
);

[in] lpName

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

[in, optional] lpValue

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

Windows Server 2003 および Windows XP: プロセスの環境ブロックの合計サイズは、32,767 文字を超えることはできません。

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

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。

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

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

要件	値
サポートされている最小のクライアント	Windows XP [デスクトップアプリ \| UWP アプリ]
サポートされている最小のサーバー	Windows Server 2003 [デスクトップアプリのみ \| UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	winbase.h (Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008 Windows Server 2008 R2 の Windows.h を含む)
Library	Kernel32.lib
[DLL]	Kernel32.dll