8.2.3 SetEnvironmentまたはSetEnv (環境変数を設定する)
- 機能
-
環境変数を設定します。
- 形式
SetEnvironment ( Type , EnvironmentName 〔, Value〕 ) SetEnv ( Type , EnvironmentName 〔, Value〕 )
- 指定項目
-
- Type
-
設定する環境変数がシステム環境変数かユーザ環境変数か,または現在のプロセスの環境変数かを指定します。
この値は次のどれかになります。
値
意味
SystemEnv
システム環境変数
設定する環境変数はコマンド実行後のシステム再起動後から有効になります。ただし,GetEnvironmentコマンドではコマンド実行後から取得できます。
UserEnv
ユーザ環境変数
設定する環境変数はコマンド実行後のシステム再起動後から有効になります。ただし,GetEnvironmentコマンドではコマンド実行後から取得できます。
ProcessEnv
現在のプロセスの環境変数
設定する環境変数はコマンド実行後の現在のプロセス内で有効になります。
SystemEnvを指定した場合,管理者権限でスクリプトファイルを実行してください。詳細は,「1.8.2 コマンドの動作」を参照してください。
- EnvironmentName
-
設定する環境変数名を文字列,または値を格納した変数名で指定します。
- Value
-
設定する値を文字列,または値を格納した変数名で指定します。
この値は省略できます。省略した場合,長さ0の文字列("")を仮定します。
この値に展開前の環境変数への参照("%PATH%"など)を含んでいてもそのままの値で設定します。
例えばValueで指定された値が"%PATH%;C:\Data"の場合,"%PATH%;C:\Data"を設定します。しかし,この環境変数を参照するときに,システムは%PATH%の部分を環境変数PATHの現在の値に置き換えた値で取得します。ただし,プロセス環境変数の場合,現在の値に置き換えられませんので例1のようにしてください。環境変数PATHが見つからない場合"%PATH%"の部分はそのままで取得します。
- 説明
-
指定された環境変数に指定された値を設定します。コマンドが正常に実行された場合は真(True)を,エラーが発生した場合は偽(False)を,コマンドの実行結果として返します。
指定された環境変数が存在しない場合は,新規に環境変数を作成し値を設定します。環境変数が存在する場合は,指定された値で更新します。
- 例1
' プロセス環境変数PATHに"C:\ABC\"を追加する Dim buff1 buff1 = GetEnvironment ( ProcessEnv ,"PATH" ) SetEnvironment ( ProcessEnv ,"PATH" ,buff1 & ";C:\ABC\" ) Exec ( "ABC.EXE" ,True )
- 例2
' システム環境変数APP_PATHにシステム環境変数PATHを設定する SetEnvironment ( SystemEnv ,"APP_PATH" ,"%PATH%" )
- 対象バージョン
-
JP1/Script 01-00以降