ObjectScript コマンド
このドキュメントでは、ObjectScript がサポートしているコマンドについて詳しく説明します。このドキュメントでは、ObjectScript コマンドが以下の 2 つのグループに分類されています。
各グループ内のコマンドの説明はアルファベット順になっています。
ObjectScript コマンドに関する全般的な詳細は、"ObjectScript の使用法" の "コマンド" の章を参照してください。
ほとんどのコマンドには省略形があります。通常は、コマンド名の最初の文字が省略形となりますが、文字 Z で始まるコマンドの場合はコマンド名の最初の 2 文字が省略形となります。各コマンドの説明では、最初に完全名を使用した構文が示され、その下に略名を使用した構文が示されます (略名がある場合)。
各コマンドの説明には、実際に構文に使用される句読点文字のみが含まれます。構文中のオプション要素を明確にするなど、形式規約のための句読点は使用されていません。その種の情報は、説明の直後にある引数のテーブルで説明されます。
1 つの例外は省略記号 (...) です。コンマの後の省略記号は、コンマの前の引数 (または引数のグループ) が、コンマ区切りリストとして複数回繰り返し可能であることを示します。中括弧の中の省略記号 { ...} は、1 つ以上のコマンドを含むコード・ブロックを中括弧内に記述できることを示します。中括弧はコード内で指定する必要のあるリテラル文字です。
ほとんどのコマンドは、1 つ以上の引数を取ります。引数とは、コマンドのアクションを定義または制御する式 (例えば、関数とその引数、変数、演算子とそのオペランド、オブジェクト・プロパティ、オブジェクト・メソッドなど) です。コマンドで複数の引数が使用される場合は、一般的に引数リストとして参照されます。一部のコマンドでは、その引数自体が引数パラメータを取る場合があります。例えば、DO コマンドの各引数はパラメータ・リストを取ることができます。これらの情報は構文に示されます。
一部のコマンドは引数なしです。つまり、引数をまったく取らずに実行できます。また、どのような状況でも引数を取らないコマンドもあれば、特定の状況でのみ引数を取るコマンドもあります。後者のコマンドでは、引数のない場合と、引数リストがある場合で、その意味が異なります。
ほとんどのコマンドは、コマンド実行の可否を決定する条件を指定する、オプションの後置条件式を取ることができます。後置条件式は、コマンド名の後にコロン (:) を使用して追加します。コマンド名とその後置条件式の間に、スペースや改行を挿入することはできません。厳密に言うと、後置条件式はコマンド引数ではありませんが、ここでは引数と一緒に説明しています。引数なしコマンドも後置条件式を取ることができます。
ほとんどの ObjectScript コマンドは、すべてのハードウェア・プラットフォーム上で同様に機能します。プラットフォーム固有のコマンド機能には、その機能を使用できるプラットフォームの種類が明示されています (Windows、UNIX® など)。プラットフォームの制限が記載されていないコマンドは、すべてのプラットフォームでサポートされます。
- BREAK (ObjectScript) – ブレークポイントで実行を中断します。ユーザの中断を有効または無効にします。
- CATCH (ObjectScript) – 例外発生時に実行するコード・ブロックを指定します。
- CLOSE (ObjectScript) – ファイルまたはデバイスを終了します。
- CONTINUE (ObjectScript) – FOR コマンド、WHILE コマンド、および DO WHILE コマンドにジャンプし、テストを再実行してループします。
- DO (ObjectScript) – ルーチンを呼び出します。
- DO WHILE (ObjectScript) – 条件が存在する間に、コードを実行します。
- ELSE (ObjectScript) – ブロック型 IF コマンドの文節です。
- ELSEIF (ObjectScript) – ブロック型 IF コマンドの文節です。
- FOR (ObjectScript) – 各ループの最初でテストしながら、コード・ブロックを繰り返し実行します。
- GOTO (ObjectScript) – 制御を移動します。
- HALT (ObjectScript) – 現在のプロセスの実行を終了します。
- HANG (ObjectScript) – 指定された秒数だけ実行を中断します。
- IF (ObjectScript) – ブーリアン式を評価し、式の真理値を基にして、実行するコード・ブロックを選択します。
- JOB (ObjectScript) – プロセスをバックグラウンドで実行します。
- KILL (ObjectScript) – 変数を削除します。
- LOCK (ObjectScript) – データ・リソースへのアクセスを制御するために、プロセスがロックを適用および解除できるようにします。
- MERGE (ObjectScript) – グローバル・ノード、もしくはサブツリーをソースから宛先にマージします。
- NEW (ObjectScript) – 空のローカル変数環境を作成します。
- OPEN (ObjectScript) – 入出力処理のためにデバイスまたはファイルの所有権を取得します。
- QUIT (ObjectScript) – ループ構造またはルーチンの実行を終了します。
- READ (ObjectScript) – 入力を受け付け、それを変数に格納します。
- RETURN (ObjectScript) – ルーチンの実行を終了します。
- SET (ObjectScript) – 値を変数に代入します。
- TCOMMIT (ObjectScript) – トランザクションの正常終了を表します。
- THROW (ObjectScript) – 次の例外ハンドラへ明示的に例外をスローします。
- TROLLBACK (ObjectScript) – 失敗に終わったトランザクションをロールバックします。
- TRY (ObjectScript) – 実行中のエラーを監視するコード・ブロックを指定します。
- TSTART (ObjectScript) – トランザクションの開始を表します。
- USE (ObjectScript) – 現在のデバイスとして、デバイスを構築します。
- VIEW (ObjectScript) – データベース・ブロックの読み取りや書き込み、メモリ内のデータの変更を行います。
- WHILE (ObjectScript) – 条件が True のときに、コードを実行します。
- WRITE (ObjectScript) – 出力を現在のデバイスに表示します。
- XECUTE (ObjectScript) – 指定されたコマンドを実行します。
- ZKILL (ObjectScript) – ノードの下位を保持しながら、そのノードを削除します。
- ZNSPACE (ObjectScript) – 現在のネームスペースを設定します。
- ZTRAP (ObjectScript) – エラーを強制し、指定されたエラー・コードを表示します。
- ZWRITE (ObjectScript) – 変数名とその値または式の値 (あるいはその両方) を表示します。
- ZZDUMP (ObjectScript) – 16 進ダンプ形式で式を表示します。
- ZZWRITE (ObjectScript) – 変数または式の値を表示します。