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 ヘッダーは SetEnvironmentVariable をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

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

関連項目

環境変数

GetEnvironmentVariable