6.1.4 予約変数

JP1/Scriptには,特定のデータ(システム情報,およびコマンドの戻り値)を参照できる「予約変数」が用意されています。

予約変数の種類と意味を表6-2に示します。

表6-2 予約変数一覧

分類予約変数意味
システム予約変数_ALLRIGHT_アドミニストレータ権限がある場合はYESになり,権限がない場合はEmpty値になります。
_BIN_実行時の起動フォルダ名です。末尾に¥が付きます。
_COMP_現在のシステムにログオンしているコンピュータ名です。
_DOMAIN_ログオンしているドメイン名です。
_OS_OSの種類とバージョンです。
  • Windows 2000の場合:WIN_NT5.0
  • Windows XPの場合:WIN_NT5.1
  • Windows Server 2003の場合:WIN_NT5.2
  • Windows Vistaの場合:WIN_NT6.0
_OS_PLATFORM_OSの種類です。
  • WIN_NT
_OS_REVISION_OSのマイナーバージョンです。
  • Windows 2000およびWindows Vistaの場合:0
  • Windows XPの場合:1
  • Windows Server 2003の場合:2
_OS_VERSION_OSのメジャーバージョンです。
  • Windows 2000,Windows XPおよびWindows Server 2003の場合:5
  • Windows Vistaの場合:6
_SCF_実行中のスクリプトファイルのフォルダ名です。末尾に¥が付きます。
_SCF_FIL_実行中のスクリプトファイルのファイル名です。拡張子は付きません。
_SCF_EXT_スクリプトファイルの拡張子(.SPT)です。
_SNF_EXT_メニュー情報ファイルの拡張子(.SPN)です。
_SVF_EXT_実行環境ファイルの拡張子(.SPV)です。
_SDF_EXT_モニタリング情報ファイルの拡張子(.SPD)です。
_SYS_MS-DOSの起動フォルダ名です。末尾に¥が付きます。
_TEMP_一時ファイル用のフォルダ名です。末尾に¥が付きます。
_USER_現在のシステムにログオンしているユーザ名です。
_WIN_Windowsフォルダ名です。末尾に¥が付きます。
_WINSYS_Windowsドライバが存在するフォルダ名です。末尾に¥が付きます。
プロセス予約変数_PROC_ID_実行中のスクリプトのプロセス識別子です。
_ARGV_%1以降の位置変数を格納した配列変数です。%0は含みません。_ARGV_(n)の形式で参照(nは1からの数字)できます。
_ARGV_CNT_%1以降の位置変数の合計数です。%0は含みません。
コマンド戻り値予約変数_COPY_RTN_Copyコマンドの実行結果です。
_COPY_CNT_Copyコマンドでコピーしたファイルの数です。
_COPY_SKIP_CNT_Copyコマンドでコピーしなかったファイルの数です。
_COPY_SKIP2_CNT_CopyコマンドのErrSkip2指定で無視されたファイルの数です。
_EXEC_RTN_Exec,NetExec,またはCallSptコマンドの戻り値です。符号付きの数値です。
_EXEC_ID_Exec,またはNetExecコマンドの実行ファイル識別子です。ただし,FlagにFalseを設定した場合(呼び出したプログラムの終了指定がなしの場合)にだけ,有効になります。
_JOB_RTN_ジョブ操作系コマンドの戻り値です。
_MSG_RTN_InputBox,またはMessageBoxコマンドの戻り値です。
_DLL_RTN_CallDllコマンドの外部関数の戻り値です。
_FORM_TERM_KEY_画面(メニューフォーム)を終了させた要因です。
_FORM_TERM_CMDNO_コマンドを実行して終了したときのコマンド番号です。
_FORM_MODIFY_KEY_画面(メニューフォーム)終了キーのモディファイキーです。
_FORM_FIELD_NAME_最後にフォーカスがあったメニュー名です。
_RTN_エラー詳細コードです。符号付きの数値です。
コマンドの戻り値がFalseの場合,設定されます。ただし,コマンドの戻り値が特定の戻り値(文字列操作コマンド,日付操作コマンド,その他のコマンドなど)の場合は,予約変数_RTN_には常に0(ゼロ)が設定されます。また,エラー詳細コードの内容は,トレースファイルに出力されるエラーメッセージの内容となります。
_RTNxx_CallDllコマンドの戻り値(xxは00からの数字)です。
_SVC_RTN_サービス操作系コマンドの戻り値です。
文字コード予約変数_NL_改行文字です。
_TAB_タブ文字です。
エラー詳細コード予約変数_NO_ERR_エラーはありません。
_ERR_EOF_ファイルの終わりに達しました。
_ERR_TIMEOUT_タイムアウト時間を経過しました。
_ERR_FILE_ファイルが見つかりません。
_ERR_PATH_パスが見つかりません。
_ERR_ACCESS_アクセスが拒否されました。
_ERR_PROTECT_書き込みが禁止されています。
_ERR_READY_デバイスが準備できていません。
_ERR_EXCLUSIVE_ファイルは他でアクセス中です。
_ERR_SVR_CONNECT_サーバが接続要求に応答しません。
_ERR_SVR_TIMEOUT_サーバからの応答待ちでタイムアウトエラーが発生しました。
_ERR_SVR_RECEIVEDATA_サーバからデータ受信中にエラーが発生しました。
_ERR_SVR_NODATA_サーバとの送受信中の無通信時間が許容時間を超えました。
_ERR_FILE_SIZE_取得した値が変数の上限値を超えているため,値を変数に格納できません。
_ERR_NOT_LARGE_FILE_指定したファイルの容量が制限値を超えています。
_ERR_FILE_POSITION_読み書き開始位置が2,147,483,647を超えています。
_ERR_SERVICE_NOT_BEGIN_JP1/Scriptサービスが実行中の状態になっていません。