8.5.2 オブジェクト操作ツールのコマンドの形式

ここでは,オブジェクト操作ツールのコマンドの入力形式および実行結果について説明します。

<この項の構成>
(1) オブジェクト操作ツールで使用するコマンドの入力形式
(2) オブジェクト操作ツールのコマンドの実行結果

(1) オブジェクト操作ツールで使用するコマンドの入力形式

コマンドの入力形式を次に示します。

コマンド名称 オプション コマンド引数

(a) コマンド名称

コマンド名称は,実行するコマンドのファイル名です。

(b) オプション

オプションの入力形式の規則を次に示します。なお,説明文で使用する「$」はコマンドプロンプト,「cmd」はコマンド名を表します。

オプションの形式
オプションはマイナス記号で始まる文字列で,次に示すように,引数を取らないか,または1個の引数を取ります。
形式1:-オプションフラグ
形式2:-オプションフラグ<空白またはタブ>フラグ引数
(凡例)
オプションフラグ:1文字の英数字で,英大文字・小文字は区別されます。
フラグ引数:オプションフラグに対する引数です。

オプションの指定規則

(c) コマンド引数

コマンド引数は,コマンド操作の直接の対象となるものを指定します。指定するコマンド引数は,各コマンドによって異なります。

詳細は各コマンドの説明を参照してください。

(d) オプションおよびコマンド引数に指定する内容について

オブジェクト操作ツールのコマンドのオプションおよびコマンド引数には,識別子,ファイルなどの記述形式が決まっている内容を指定します。このような識別子,ファイルの種類を次の表に示します。

表8-8 オプションおよびコマンド引数に指定する識別子とファイル

種類説明記述方法
OIIDすべてのオブジェクトにプロパティとして付けられている識別子です。文書空間識別子,文書空間特有のオブジェクトの識別子などから構成され,「dma://」で始まるURLの形式で定義されています。

dma:///07a17522-a626-11d0-b11f-0020af27a837/…00000000001​

…は,途中の省略を示します。
OIIDファイル複数のオブジェクトを一括して操作する場合に,操作対象となるオブジェクトのOIIDを記述するファイルです。実行する処理に応じて,OIIDの一覧を記述します。
問い合わせファイル問い合わせの実行コマンド(dbrexquery)で実行する問い合わせ式を記述するファイルです。実行する処理に応じて,オブジェクトを検索するための問い合わせ式を記述します。
次に示す個所を参照してください。
プロパティ情報ファイル次のようにプロパティを設定,参照または更新する場合に記述するファイルです。
  • オブジェクトを作成する時にプロパティの初期値を設定する場合
  • オブジェクトに設定されているプロパティを参照する場合
  • オブジェクトに設定されているプロパティを更新する場合
実行する処理に応じて,オブジェクトに設定するプロパティ情報を記述します。
次に示す個所を参照してください。

(2) オブジェクト操作ツールのコマンドの実行結果

オブジェクト操作ツールのコマンドの戻り値と実行結果について説明します。

(a) 戻り値

戻り値は,オブジェクト操作ツールのすべてのコマンドで共通です。コマンドの終了状態によって,次の表に示す値を返却します。

表8-9 戻り値一覧

戻り値意味
0正常終了
1警告つき正常終了
2引数不正による異常終了
それ以外そのほかの異常終了
(b) 実行結果