Btrieve API オペレーション
ここでは、アプリケーションが Btrieve API を使って実行できるオペレーションについて説明します。各オペレーションに、次の情報があります。
• オペレーションの名前、コードおよび説明。
• パラメーター - オペレーションを実行する際に、6 個のパラメーターのうちのどの値がアプケーションから送られ、アプリケーションに返されるのかを表に示しています。「送り値」パラメーターは、アプリケーションからオペレーションに送られます。「戻り値」パラメーターは、オペレーション完了後にオペレーションからアプリケーションに返されます。
• 前提条件 - オペレーションを正常に実行させるためにアプリケーションが満たすべき条件を示します。
• 手順 - オペレーションが要求するパラメーターを初期化する手順を示します。
• 詳細 - オペレーションについての追加情報を示します。
• 結果 - オペレーションが正常に終了した場合と、何らかのエラーが発生した場合の結果を示します。それぞれのオペレーションは、オペレーションの結果をアプリケーションに通知するステータス コードを返します。ステータス コード 0 は、オペレーションが正常に終了したことを示します。0 以外のステータス コードは、通常は何らかのエラーが発生したことを示します。ただし、0 以外のステータス コードの中には、単に情報を提供するだけで、関連するオペレーションが正常に終了したときにも示されるものがあります。たとえば、ステータス コード 60 は指定したリジェクト カウントに到達したことを意味します。
• ポジショニング - オペレーションがファイル内のレコードの論理カレンシーまたは物理カレンシーに与える影響を示します。
Btrieve API オペレーションの一覧をアルファベット順に示します。
Abort Transaction（21）
Abort Transaction オペレーション（B_ABORT_TRAN）では、現在のトランザクションを終了し、このトランザクションの開始以降に実行されたすべてのオペレーションの結果を削除します。また、トランザクションによって設定されたすべてのファイルとレコードのロックを解除します。
パラメーター
前提条件
Abort Transaction オペレーションを発行する前に、Begin Transaction（19 または 1019）オペレーションが正常に実行されている必要があります。
手順
オペレーション コードを 21 に設定します。MicroKernel エンジンでは、オペレーション コード以外の Abort Transaction 呼び出しパラメーターはすべて無視されます。
結果
Abort Transaction オペレーションが正常に終了した場合は、MicroKernel エンジンからステータス コード 0 が返されます。トランザクションの開始以降に発行されたすべての Insert、Update、および Delete オペレーションの結果がファイルから削除されます。
Abort Transaction オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Abort Transaction オペレーションは、ファイルのカレンシー情報にまったく影響しません。
Begin Transaction（19 または 1019）
Begin Transaction オペレーション（B_BEGIN_TRAN）では、トランザクションの開始を定義します。トランザクションは、複数の Btrieve API オペレーションを単一イベントとして実行する必要がある場合に有用です。たとえば、いくつかのオペレーションのうち少なくとも 1 つでもオペレーションが正常に終了しないと、データベースの論理的整合性が保てなくなる場合には、トランザクションを使用してください。
一連のオペレーションを Begin Transaction と End Transaction オペレーションで囲んでおくと、明示的な
End Transaction（20）でトランザクションの完了を要求しない限り、MicroKernel エンジンはその間に実行された複数のオペレーションをすべて取り消すことができます。トランザクション内で加えられた変更は、End Transaction オペレーションの実行が正常に終了するまで、ほかのユーザーからは見ることができません。
MicroKernel エンジンは、ファイルやパフォーマンスに多大な影響を与えるという理由で、いくつかのオペレーションについてトランザクション中の実行を禁止しています。この特定のオペレーションとは、
Set Owner（29）、
Clear Owner（30）、
Create Index（31）、および
Drop Index（32）です。
パラメーター
前提条件
Begin Transaction を発行する前に、先行するトランザクションを終了または中止しておく必要があります。
手順
オペレーション コードを 19 に設定して排他トランザクションを開始するか、1019 に設定して並行トランザクションを開始します。MicroKernel エンジンでは、オペレーション コード以外の Begin Transaction 呼び出しパラメーターはすべて無視されます。
Begin Transaction オペレーションでは、デフォルトのロック バイアスを指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
並行トランザクションの Begin Transaction オペレーションでは、+500 をオペレーション コードに追加できます（1519）。追加すると、トランザクション内の Insert、Update、Delete の各オペレーションが、MicroKernel エンジンによって再試行されなくなります。
さらに、+500 バイアスをデフォルトのロック バイアスと組み合わせることもできます。たとえば、1019 + 500 + 200（1719）を使用すると、Insert、Update および Delete オペレーションの再試行を抑え、並行トランザクションが実行されます。また同時に、単一レコードの読み取りノーウェイト ロックが指定されます。
メモ： レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
結果
Begin Transaction オペレーションが正常に終了した場合は、MicroKernel エンジンからステータス コード 0 が返されます。
Begin Transaction オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Begin Transaction オペレーションは、ファイルのカレンシー情報にまったく影響しません。
Clear Owner（30）
Clear Owner オペレーション（B_CLEAR_OWNER）では、あらかじめ Set Owner オペレーションを使ってファイルに割り当ててあるオーナー ネームを削除します。ファイルがあらかじめ暗号化されている場合は、Clear Owner オペレーションの実行中に MicroKernel エンジンによってファイルの解読も行われます。詳細については、『
Advanced Operations Guide』の
オーナー ネームを参照してください。
パラメーター
前提条件
• 対象となるファイルが開いており、オーナー ネームが指定されていることが必要です。
• トランザクションが実行中でないことが必要です。
手順
1. オペレーション コードを 30 に設定します。
2. 対象となるファイルを識別するポジション ブロックを渡します。
結果
Clear Owner オペレーションが正常に実行されると、それ以降、MicroKernel エンジンはファイルを開いたり変更したりするときにオーナー ネームを要求しなくなります。オーナーを割り当てるときにファイルのデータを暗号化した場合には、MicroKernel エンジンは Clear Owner オペレーションの実行中にデータの解読も行います。暗号化されているデータが多いほど、Clear Owner オペレーションの実行にかかる時間は長くなります。
Clear Owner オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Clear Owner オペレーションは、ファイルのカレンシー情報にまったく影響しません。
Close（1）
Close オペレーション（B_CLOSE）では、指定されたポジション ブロックに関連付けられているファイルを閉じ、そのファイルに対して実行されたロックをすべて解除します。ファイルへのアクセスを終了するとき、アプリケーションでは必ず Close オペレーションを実行する必要があります。Close オペレーションの実行後は、もう一度 Open（0）を発行しない限り、そのファイルにはアクセスできなくなります。
トランザクション中でも、ファイルを閉じることができます。ただし、Close オペレーションを実行しても、トランザクションは終了しません。トランザクションは明示的に終了または中止する必要があります。トランザクションを中止すると、トランザクション中に行われた変更は打ち切られます。トランザクションを終了すると、変更が反映されます。
メモ： トランザクション中にファイルを閉じた場合、MicroKernel エンジンではそのファイルへの更新を正しく処理できるように、トランザクションが中止または終了されるまでファイルのオープン ハンドルを保持します。ただし、そのファイルのポジション ブロックをアプリケーションで使用することはできなくなります。
パラメーター
前提条件
対象となるファイルが開いていることが必要です。
手順
1. オペレーション コードを 1 に設定します。
2. 閉じるファイルに対応する有効なポジション ブロックを渡します。
結果
Close オペレーションが正常に終了した場合は、閉じたファイルに対応するポジション ブロックは有効でなくなります。
Close オペレーションが失敗した場合は、ファイルが開いたままになり、MicroKernel エンジンから次のステータス コードが返されます。
ポジショニング
Close オペレーションを実行すると、ファイルの物理カレンシー情報および論理カレンシー情報は消去されます。
Continuous Operation（42）
Continuous オペレーション（B_CONTINOUS）では、アクティブな MicroKernel エンジン ファイルを閉じることなく、システム バックアップを実行できます。ファイルのバックアップ中に行った変更は、デルタ ファイルと呼ばれる一時ファイルに記憶されます。デルタ ファイルに書き込まれた変更を除き、Continuous オペレーション モードに置かれたすべてのファイルの内容がシステム バックアップの対象になります。バックアップされたファイルが Continuous オペレーション モードから抜けると、MicroKernel エンジンにより、デルタ ファイルの変更がこれらのファイルに自動的にロール インされます。
メモ： このオペレーションは、ローカル エンジンで動作しているアプリケーションにのみ使用できます。クライアント アプリケーションはリモート マシンにあるファイルに対してこのオペレーションを使用することはできません。
このオペレーションを使うと、ファイルがアクティブな状態のまま、それを安全にコピーできます。クライアント/サーバー セットアップでは、あるファイルで Continuous オペレーションを開始するクライアントは、そのファイルで Continuous オペレーションを終了するクライアントでもなければなりません。
パラメーター
メモ： キー番号パラメーターの値が 0（Continuous オペレーション モードを開始）または 2（Continuous オペレーション モードを終了）の場合にのみ、データ バッファー パラメーターおよびデータ バッファー長パラメーターの値が必要です。以下に、これらのキー番号の値について説明します。キー番号パラメーターが 1 の場合、データ バッファー長は 0 である必要があります。
手順
Continuous オペレーション モードを開始するには、以下の手順を実行してください。
1. バックアップの対象となるファイルまたはファイルのセットを定義するか、目的のファイルを現在バックアップの対象として定義されているファイルのセットに追加します。
a. オペレーション コードを 42 に設定します。
b. Continuous オペレーション モードに置くファイルの名前をデータ バッファー パラメーターに入れます。サーバー名のみを除いた絶対パス名を入れます。名前をカンマで区切り、リストの最後にバイナリ 0 を付けます。
次の例は、Windows サーバーの場合の例です。
f:\acct\march.mkd,f:\acct\april.mkd
c. 名前の長さをデータ バッファー長パラメーターに入れます。この値は、データ バッファー自体に入っている、バイナリ 0 を含めた実際の名前の長さ以上の値にする必要があります。たとえば、例に挙げた名前の場合、データ バッファー長には 40 以上の値を入れることが必要です。
d. キー番号パラメーターを 0 に設定します。
2. バックアップを実行します。
3. Continuous オペレーション モードを終了します。
a. オペレーション コードを 42 に設定します。
b. キー番号パラメーターを 1 に設定します。
1 つまたは複数の特定のファイルで Continuous オペレーションを終了するには、キー番号パラメーターを 2 に設定し、手順 1b で説明したようにファイル名をデータ バッファー パラメーターに入れます。さらに、手順 1c で説明したように、名前の長さをデータ バッファー長パラメーターに入れます。
詳細
一連のファイルをバックアップするように定義する場合は、以下の点に留意してください。
• MicroKernel エンジンは、データ バッファーにファイル名が入っていなくてもエラーと見なしません。ファイル名が見つからない場合、MicroKernel エンジンは Continuous オペレーションで何の動作も行いません。
• データ バッファーに重複するファイル名が存在しても、Continuous オペレーションの動作状況には影響しません。MicroKernel エンジンでは、指定したファイルを 1 度だけ Continuous オペレーション モードに置きます。
• 同じディレクトリに、ファイル名が同一で拡張子のみが異なるようなファイルを置かないでください。たとえば、Invoice.btr という名前のデータ ファイルと Invoice.mkd という名前のファイルが同じディレクトリ内にあってはなりません。このような制限が設けられているのは、データベース エンジンがさまざまな機能でファイル名のみを使用し、ファイルの拡張子を無視するためです。Continuous オペレーションでは、デルタ ファイル名として、対応するファイルの名前に拡張子「.^^^」を付けた名前を使用します。MicroKernel エンジンは両方のファイルについて同一のデルタ ファイルに書き込もうとするため、データの破損につながるか、またはステータス 85 が返される可能性があります。また、これらのファイルが Continuous オペレーション モードに置くファイルの大きなリストの一部であったとしても、この状況が発生する場合には、ファイルは一切 Continuous オペレーション モードに置かれません。
• アプリケーションでは、Continuous オペレーションを反復的に呼び出して、Continuous オペレーション モードに置くファイルのリストにファイル名を追加できます。ただし、リレーショナル エンジンによってファイルの一部に参照整合性（RI）制約が設定されている場合は、この操作により、バックアップが壊れる可能性があります。参照整合性制約と関連付けられているファイルは、単独の Continuous オペレーション呼び出しで渡す必要があります。
既に Continuous オペレーション モードに入っているファイルを指定すると、MicroKernel エンジンからステータス コード 88 が返されます。
Continuous オペレーションを呼び出すサーバー ベースのアプリケーションを作成する場合は、必ず BTRVID を呼び出し、有効なクライアント ID を使用することで、同一クライアントのもとで Continuous オペレーションの開始と終了を行えるようにします。
Btrieve API では、BTRVID 関数を使ってバックアップ セットごとに異なるクライアント ID を指定し、複数のバックアップ セットを定義できます。ただし、同じファイルを 2 つのセットに入れることはできません。
MicroKernel エンジンによってデルタ ファイルからデータ ファイルに変更内容がロール インされているときでも、ユーザーは通常の場合と同じように、MicroKernel エンジン ファイルの更新、挿入および読み取りを引き続き実行できます。MicroKernel エンジンは挿入作業で必要となれば、変更内容のロール イン中でもデルタ ファイルに新しいページを追加します。このため、変更内容が失われることはありません。
メモ： デルタ ファイルは決して手動で削除しないでください。
アプリケーションで BTRV 関数を使用する場合は、ファイルが Continuous オペレーション モードに入っているときにそのアプリケーションをアンロードしないでください。アンロードすると、対象となるファイルを Continuous オペレーション モードから削除できなくなることがあります。これは、対象となるファイルのオーナーとして MicroKernel エンジンが当初割り当てたデフォルトのクライアント ID が、別のアプリケーションに再割り当てされてしまう可能性があるからです。MicroKernel エンジンでは対象となるファイルの正しいオーナーがわからなくなるため、それらのファイルを Continuous オペレーション モードから削除できなくなってしまいます。
Continuous オペレーション モードに入るとき、または MicroKernel エンジンによってデルタ ファイルからデータ ファイルに変更内容がロール インされている最中にシステムがクラッシュした場合は、システムの再起動後初めてそのファイルを開くときに、MicroKernel エンジンによってすべての変更内容がファイルにロール インされます。
結果
Continuous オペレーションが正常に終了した場合、MicroKernel エンジンからステータス コード 0 が返されますが、データ バッファーおよびデータ バッファー長パラメーターには何の値も返されません。
このオペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
上記のコードに加え、アプリケーションにはステータス コード 18 のような標準の I/O エラーが返されることがあります。
MicroKernel エンジンから 0 以外のステータス コードが返される場合、Continuous オペレーションは、エラーを発生させた入力文字列の一部をデータ バッファーに返します。入力文字列が使用されていない場合、データ バッファーにはエラーの原因となったファイル名が返されます。データ バッファー長には、データ バッファー内の出力文字列の長さが反映されます。この場合は、エラーの原因となったファイル名の長さが入ります。
ポジショニング
Continuous オペレーションを実行しても、ファイルにカレンシーは確立しません。
Create（14）
Create オペレーション（B_CREATE）では、アプリケーション内から新しいデータ ファイルを生成します。Create オペレーションにはファイルの削除または名前変更ができるサブファンクションもあります（
Create オペレーションによる削除および名前変更サブファンクションを参照）。
メモ： 同じディレクトリに、ファイル名が同一で拡張子のみが異なるようなファイルを置かないでください。たとえば、同じディレクトリ内のデータ ファイルの 1 つに Invoice.btr、もう 1 つに Invoice.mkd という名前を付けてはいけません。このような制限が設けられているのは、データベース エンジンがファイル名のみを使用し、ファイルの拡張子を無視する場合もあるからです。この場合、ファイルの拡張子だけが異なるファイルは、データベース エンジンでは同一のものであると認識されます。
パラメーター
前提条件
既存のファイルを基に空のファイルを作成する場合は、Create オペレーションを実行する前にその既存ファイルを閉じておく必要があります。
手順
1. オペレーション コードを 14 に設定します。
2. 詳細の説明に従い、データ バッファーにファイル仕様、キー仕様、およびオルタネート コレーティング シーケンス（ACS）を設定します。ファイル仕様とキー仕様の値はすべて、バイナリ形式でなければなりません。
3. データ バッファー長を設定します。これは、Create の指定を含むバッファーの長さであり、ファイルのレコード長ではありません。
4. キー バッファーにファイルのパス名を設定します。パス名の終端は空白かバイナリ ゼロにします。パス名は、ボリューム名および終端文字を含めて、255 文字までの範囲で指定することができます。
5. キー番号パラメーターの値を、
キー番号の選択肢のいずれかを使って設定します。
詳細
データ バッファーには、作成するファイルの仕様とキーの仕様を格納します。Create（14）と
Stat（15）は同様のデータ バッファー構造体を使用するため、それらのわずかな違いも含め、ここでまとめて説明されています。以下の表は、BTRV タイプおよび BTRVEX タイプのエントリ ポイントに関する情報の構造体を示しています。どちらのタイプも
Btrieve API 関数で説明されています。
2 つのタイプのエントリ ポイント間には、仕様内の要素の順序に違いがあることに留意してください。詳細については、
キー仕様ブロックおよび
ファイル仕様ブロックを参照してください。以下の表に示すように、データ バッファーにはファイル仕様と、0 個以上のキー仕様ブロック、0 個以上の ACS ブロックを格納します。
Create および Stat で使用される BTRV タイプのエントリ ポイントのファイル仕様
Create および Stat で使用される BTRVEX タイプのエントリ ポイントのファイル仕様
ファイル仕様ブロック
データ バッファーの先頭 16 バイトまたは 32 バイトにはファイル仕様を格納します。バイト番号は 0 から始まります。レコード長、ページ サイズ、およびインデックス数の情報を整数で格納します。
論理固定レコード長
論理レコード長は、ファイル内の固定長データのバイト数です。論理レコード長には可変長データを含めないでください。
ページ サイズ
ページ サイズはファイル形式のバージョンによって決まっています。『
Zen Programmer's Guide』の
ページ サイズの選択を参照してください。次の表は、さまざまなファイル形式バージョンのページ サイズの例を示しています。
レコード数
ファイル内のレコード数です。この値は Stat（15）によって返されます。Create（14）では、このフィールドを 0 に設定します。
キー数
インデックス数はファイルに対して定義しているキーの数です。キー セグメント数ではありません。データオンリー ファイルを作成するには、インデックス数を 0 に設定します。
ファイル バージョン
作成する MicroKernel エンジンのファイル バージョンです。以前のリリースでは、MicroKernel エンジンは 2 バイト整数を使って Create オペレーションでインデックス数を取得していました。インデックスの最大数は 119 であるため、この整数の上位バイトは常に 0 でした。この上位バイトは、これまで Stat（15）オペレーションでファイル バージョンを返すために使用されてきましたが、Create でファイル バージョンを指定するために使用できるようになりました。これにより、以前のアプリケーションでエラーが発生することはありません。Create でサポートされるファイル バージョンは 6.0、7.0、8.0、9.0、9.5、13.0、および 16.0 です。これらは、それぞれ 16 進数の値 0x50、0x60、0x70、0x80、0x90、0x95、0xD0、0xD3 で特定のバイトに示されます。次の表は、さまざまなファイル形式バージョンのファイル バージョン フラグの値を示しています。
追加ポインター数
Create（14）の場合は、将来のキーの追加のために予約する重複ポインター数です。Stat（15）の場合は、残っているポインター数です。予約重複ポインター フラグと共に使用されます。このフラグを使用しないときは、このフィールドを 0 に設定します。
物理ページ サイズ
ページ圧縮ファイル フラグが設定されている場合に使用されます。ページ圧縮フラグが指定されていない場合は、このフィールドを 0 に設定します。このフィールドは、以前は「未使用」とマークされていました。
バージョン 6.x 以降のデータ ファイルでは、論理ページは物理ページに割り当て、ページ アロケーション テーブル（PAT）に格納します。物理ページのサイズは論理ページのサイズと同一です。ページ圧縮は 9.5 以降のファイル形式で使用できます。データベース ページはページ レベルで圧縮されます。各論理ページは、1 つ以上の物理ページ単位に圧縮されます。これら個々の物理ページのサイズは、1 論理ページよりも小さくなります。
物理ページ サイズ フィールドを使用して、ファイルで使用する物理ページ サイズを指定できます。このフィールドで指定する値は、使用される実際の物理ページ サイズを決定するため、512 の倍数にします。0 を指定すると、エンジンは物理ページ サイズのデフォルト値の 512 を使用します。
物理ページ サイズに指定された値は、論理ページ サイズに指定された値よりも大きくすることはできません。物理ページ サイズに指定された値の方が大きい場合、エンジンは論理ページ サイズと同じになるようその値を切り捨てます。論理ページ サイズは物理ページ サイズの倍数になっていなければなりません。倍数でない場合、その論理ページ サイズの値は物理ページ サイズの値のちょうど倍数になるよう切り捨てられます。このような操作の結果として、論理ページ サイズと物理ページ サイズの値が同じになった場合、ページ レベルの圧縮はこのファイルに適用されません。『
Zen Programmer's Guide』の
ページ レベル圧縮を用いたファイルの作成も参照してください。
ファイル フラグ
ファイル フラグ ワードのビットをセットして、ファイル属性を指定します。次の表に、ファイル フラグの値の 2 進、16 進、および 10 進表記を示します。
互換性のないフラグの使用は避けてください。同一ビット位置を使用するフラグ間には互換性はありません。未使用のビットは将来使用するために予約されています。これらのビットを 0 に設定します。
ファイルの属性を組み合わせるには、対応するファイル フラグの値を加算します。たとえば、可変長レコードを含むことができ、ブランク トランケーションを行うファイルを指定するには、ファイル フラグ ワードを 3（2 + 1）に初期化します。可変長レコードのビットが 0 に設定されている場合、MicroKernel エンジンではブランク トランケーションおよび空きスペース スレッショルドのビットを無視します。
ページ プリアロケーションのビットを設定する場合は、ファイル仕様ブロック（アロケーション）の最後の 2 バイトを使用して、ファイルにプリアロケートするページ数を指定する整数値を格納してください。データ圧縮のビットを設定した場合、MicroKernel エンジンでは可変長レコードのビットが無視されます。
データベース エンジンは、システム データを使用しており、レコード長が許容最大サイズより大きいファイルについては自動的にデータ圧縮を使用します。『
Zen Programmer's Guide』の
レコード長を参照してください。
ファイルを作成した後でインデックスの追加が予想される場合、および、そのインデックスには重複した値が含まれるが、繰り返し重複としてマークされない場合は、重複ポインターのビットを設定します。このビットを設定すると、MicroKernel エンジンでは重複した値をリンクするポインターのためにファイルの各レコードにスペースが確保されるようになります。このようなスペースを確保することにより、特に、キーが長く、多数のレコードが重複するキー値を持つことが予測される場合には、検索時間を短縮し、ディスク領域を節約できる場合があります。
メモ： 重複ポインターの領域は、ファイル作成後に追加されるインデックスのみを対象に予約できます。したがって、重複値へのポインターのために領域を確保するときは、この Create オペレーションの実行中に作成されるインデックスの領域は含めないでください。また、繰り返し重複キーとして指定されるキーについて、MicroKernel エンジンは重複ポインターの領域を確保しません。
特定の番号をキーに割り当てることが必要な場合は、キー番号のビットを設定し、希望するキー番号をキー仕様ブロックの手動割り当てキー番号要素（オフセット 0x0E）に入れます。MicroKernel エンジンではキー番号が連続している必要はありません。つまり、ファイルのキー番号は飛んでいてもかまいません。キーが作成されると、MicroKernel エンジンはデフォルトで、0 から始まるキー番号のうち使用可能な最小の番号をそのインデックスに割り当てます。ただし、アプリケーションによっては、デフォルトの割り当てとは異なるキー番号が必要なこともあります。
ファイルで可変長部割り当てテーブルを使用する場合は、VAT の使用のビットを設定します。VAT を使うには、ファイルで可変長レコードを使用していることが必要です。
プリアロケート ページ数
プリアロケートするページ数を指定できます。ページ プリアロケーションのファイル フラグを指定した場合にのみ、この要素を使用してください。詳細については、『
Zen Programmer's Guide』の
ページ プリアロケーションを参照してください。
キー仕様ブロック
ファイル仕様のすぐ後に 0 個以上のキー仕様ブロックを配置します。ファイルのキー セグメントごとに 16 バイトまたは 24 バイトののキー仕様ブロックを割り当てます。キー ポジションおよびキー長の情報は整数で格納します。
次の表で示すように、許容されるキー セグメントの最大数は、ファイルのページ サイズおよびファイル形式によって決まります。
『
Status Codes and Messages』のステータス コード
26：指定されたキーの数が無効です。および
29：キー長が無効です。を参照してください。
次の表は、Create（14）または Stat（15）オペレーションのキー セグメントのデータ バッファー構造体を示しています。各キー仕様ブロックは、BTRV タイプのエントリ ポイントの場合は 16 バイト、BTRVEX タイプのエントリ ポイントの場合は 24 バイトです。2 つのデータ型が示されている場合、1 つめは BTRV で使用され、2 つめは BTRVEX で使用されます。オフセットは、各キー ブロックについて繰り返されます。
キー ポジション
キー ポジションは、キーまたはキー セグメントの開始位置のバイト オフセットです。ポジションは 1 からの相対になります。レコードの先頭に位置するキーは、ポジション 1 から始まります。ポジション 0 はありません。
キー長
キーまたはキー セグメントの長さです。キーの最大長は、すべてのセグメントを含めて、13.0 以前の形式のファイルでは 255 バイト、16.0 形式のファイルでは 1024 バイトです。
キー フラグ
キー フラグ ワードのビットをセットして、キー属性を指定します。次の表に、キー フラグの値の 2 進、16 進、および 10 進表記を示します。
互換性のないフラグの使用は避けてください。同一ビット位置を使用するフラグ間には互換性はありません。未使用のビットは将来使用するために予約されています。これらのビットを 0 に設定します。
キーの属性を組み合わせるには、それらの値を合計します。たとえば、キーが拡張キー タイプで、セグメント キーの一部であり、さらに降順に照合される場合は、キー フラグ ワードを 336（256 + 16 + 64）に初期化します。
セグメント キー属性は、データ バッファー内の次のキー仕様ブロックが同一キーの次のセグメントを指すことを示します。セグメント キーについては以下の規則に従ってください。
• 同一キーのすべてのセグメントで、重複可能、繰り返し重複、変更可能、およびヌル キーの値はそれぞれ同じでなければなりません。レガシー ヌル キー属性を指定する場合は、全セグメントまたは一部セグメントのどちらの場合にも、セグメントごとに異なるヌル値を割り当てることができます。
• 同一キーのすべてのセグメントで、同一 ACS（オルタネート コレーティング シーケンス）を使用する必要があります。
• 同一キーのセグメントごとに、異なる降順ソートおよび拡張データ型の値を設定できます。
ACS は、STRING、LSTRING、ZSTRING、WSTRING、および WZSTRING 型のキーにのみ適用されます。大文字小文字の区別を無視し、かつ ACS を使用するキーを定義することはできません。あるキーの一部のセグメントにしか ACS が指定されていないファイルの場合、ACS が指定されているセグメントはその ACS に従ってソートされるのに対し、ACS が指定されていないセグメントはそれぞれの型に従ってソートされます。
拡張データ型
拡張データ型をキー仕様ブロックのバイトにバイナリ値で指定します。次の表に拡張データ型に対応するコードを示します。
拡張データ型のコード 12、13、16、および 22 から 24 までは将来使用するために予約されています。CLOB 型は Get Extended オペレーションに含まれていますが、インデックスの作成に使用することはできません。
STRING および UNSIGNED BINARY データ型は、標準型と拡張型のどちらとしても定義できます。これにより、以前のバージョンの Btrieve API を使って開発したアプリケーションとの互換性が保てる一方、新しいアプリケーションで拡張データ型を排他的に使用できるようになります。
キーに割り当てるデータ型に関し、入力したレコードがそのキーに定義されているデータ型に合っているかどうかは、MicroKernel エンジンでは確認されません。たとえば、TIMESTAMP キーをファイルに定義することができますが、そこに文字列を格納することもできます。Btrieve API アプリケーションでは問題なく動作していても、ODBC アプリケーションで同じデータに ODBC TIMESTAMP データ型を使ってアクセスしようとすると、正常に動作しないことがあります。これはおそらく、バイトの形式が異なり、タイムスタンプ値を生成するアルゴリズムが異なるからです。データ型の説明については、『
SQL Engine Reference』の
Btrieve キーのデータ型を参照してください。
ヌル値
キーの除外値を表します。あるキーをヌル キーとして定義した場合は、各キー セグメントのヌル値として認識させる値を MicroKernel エンジンに提供する必要があります。これは、レガシー ヌルへの参照内にあり、真のヌルには影響しません。ヌル サポートの説明については、『
Zen Programmer's Guide』の
ヌル値を参照してください。
手動割り当てキー番号
MicroKernel エンジンでは、インデックス付きのファイルを作成するときに、アプリケーションで特定のキー番号を割り当てることができます。ファイルの各インデックスに手動でキー番号を割り当てるには、各キーの番号をキー仕様ブロックにバイナリ値で指定し、ファイル フラグ ワードにキー番号ビット（0x400）を設定します。
キー番号はファイルで一意であり、キー 0 から昇順に指定されていなければなりません。また、有効な値、つまり、ファイルのページ サイズに対するキーの最大数よりも小さい値でなければなりません。
手動でキー番号を割り当てるという機能は、キーを削除して、その削除したキーよりも大きなキー番号を持つすべてのキーの番号を MicroKernel エンジンに付け替えさせないようにする機能と相補関係にあります。たとえば、アプリケーションからインデックスを削除し、MicroKernel エンジンにそれよりも大きな番号を持つキーの番号を付け替えないように指示を出した場合、その後でユーザーが具体的なキー番号を割り当てずに影響を受けたファイルを複製すると、複製したファイルには元のファイルとは別のキー番号が割り当てられます。
ACS 番号
特定の ACS を使用するキーの場合、キー仕様ブロックにより、キーの照合に使用する ACS 番号が示されます。ACS 番号はデータ バッファー内の位置に基づいて決まります。最後のキー仕様ブロックに続く最初の ACS は、ACS 番号 0 になります。ACS 0 の次には ACS 1、その次には ACS2、というように続きます。
オルタネート コレーティング シーケンス（ACS）
照合順序（コレーティング シーケンス）は、Create オペレーションのデータ バッファーで、最後のキー仕様ブロックの直後から 1 つずつ順番に現れます。以下の表で、ACS、ISR、または ICU 照合順序を指定するために使用される 265 バイトについて説明します。
ユーザー定義の ACS ファイル
文字列値を ASCII 標準とは異なる並び順でソートする ACS を作成するには、アプリケーションで次のデータ バッファーに直接 265 バイトを設定する必要があります。
ユーザー定義の ACS ファイルの例については、『
Zen Programmer's Guide』の
オルタネート コレーティング シーケンスを参照してください。
インターナショナル ソート規則（ISR）
ISR テーブル名を指定するには、アプリケーションで次のデータ バッファーに直接 265 バイトを設定する必要があります。
Unicode 照合順序
ICU（International Components for Unicode）標準に従って Unicode 照合順序を指定するには、アプリケーションで次のデータ バッファーに直接 265 バイトを設定する必要があります。
データ バッファー長
データ バッファーは、ファイル仕様、キー仕様、および定義されている ACS ファイルを十分に格納できるだけの長さを持つ必要があります。このパラメーターにファイルのレコード長を指定しないでください。
たとえば、BTRV エントリ ポイントを使用して、1 セグメントのキーを 2 つと ACS を 1 つ持つファイルを作成するには、Create オペレーションのデータ バッファーには、以下のように少なくとも 313 バイトの長さが必要です。
キー番号
Create オペレーションのキー番号は、同名のファイルが既に存在する場合に MicroKernel エンジンが警告を出すかどうか、また、ファイルの作成時に MicroKernel エンジンがローカル エンジンとリモート エンジンのどちらを使用するかを決定します。
次の表を使って、キー番号パラメーターの値を選択します。
Create オペレーションによる削除および名前変更サブファンクション
Create オペレーションには 2 つのサブファンクションがあり、これを使用してファイルの削除または名前変更ができます。
Pervasive.SQL v8.5 より前は、オペレーティング システムを介して MicroKernel エンジン ファイルを操作することは可能でした。これは、オペレーティング システムが Zen ユーザーに与える権限にエンジンが依存していたためです。
v8.5 で Zen データベース セキュリティが導入されると、承認されていないアクセスに対しデータベースがセキュリティで保護されている場合には、このようなオペレーティング システムのアクセス権は除去されることがあります。オペレーティング システムの権限が常に利用できるとは限らなくなるため、プログラムによるファイルの削除や移動のためのオプションは変更される可能性があります。
名前変更と削除のサブファンクションは、代替キー番号を持つ Create オペレーションとして実装されています。新規データ ファイルを作成する場合のようにファイル仕様を指定する必要はありません。Create オペレーションで名前変更および削除サブファンクションを使用するための設定方法を、次の表に示します。
これらのサブファンクションはセキュリティ モデルで動作するように変更されました。その変更点として、サブファンクションは削除または名前変更する MicroKernel エンジン ファイルを示すために、必要に応じて、キー バッファーおよびデータ バッファーでファイル名の代わりに URI を受け入れるようになりました。これにより、セキュリティ情報をオペレーションに指定することができます。URI 接続文字列の詳細については、『
Zen Programmer's Guide』の
データベース URI を参照してください。
セキュリティ情報は、通常の Create または Open オペレーションと同様に処理されます。ユーザーは認証され、かつ、既存のファイルに対して、また新しいファイルの保存場所となるディレクトリに対して DB_RIGHT_CREATE、DB_RIGHT_ALTER、および DB_RIGHT_OPEN 権限を持っている必要があります。
次の Create サブファンクションの表で、X はキー バッファーで有効な URI パラメーターを示します。
次の Create サブファンクションの表で、X はデータ バッファーで有効な URI パラメーターを示します。
名前変更および削除サブファンクションでの注意
• RenameFile および DeleteFile サブファンクションは種々雑多なページの内容には影響しないため、特定のデータベースにバインドされているファイルに使用することはできません。
• ファイルにオーナー ネームが含まれている場合、新しいサブファンクションではオーナー ネームのチェックは行われません。オーナー ネームはファイルの内容を表示させるためには、引き続き必要です。
結果
Create オペレーションが正常に終了した場合は、MicroKernel エンジンから同名のファイルが既に存在すると警告されるか、仕様に従って新しいファイルが作成されます。新規ファイルにはレコードは含まれていません。Create オペレーションでは作成したファイルを開きません。したがって、ファイルにアクセスするには、アプリケーションで Open オペレーションを実行する必要があります。
Create オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Create オペレーションを実行しても、ファイルにカレンシーは確立しません。
Create Index（31）
Create Index オペレーション（B_BUILD_INDEX）では、既存のファイルにキーを追加します。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイル内の既存のキー セグメント数は、許容されるキー セグメントの最大数から追加するキー セグメント数を差し引いた値以下でなければなりません。
• 許容されるキー セグメントの最大数は、ファイルのページ サイズによって決まります。次の表は、これらの値の一覧を示します。
『
Status Codes and Messages』のステータス コード
26：指定されたキーの数が無効です。および
29：キー長が無効です。を参照してください。
• 新しいキーのキー フラグ、位置および長さが、キーを追加しようとしているファイルに対して適切であることを確認します。
• トランザクションが実行中でないことが必要です。
手順
1. オペレーション コードを 31 に設定します。
2. キーを追加するファイルのポジション ブロックを渡します。
3. キーの各セグメントについて、キー仕様ブロックをデータ バッファーに格納します。
Create（14）で説明されているものと同じ構造体を使用します。キー ポジションおよびキー長の情報は整数で格納します。システム定義のログ キー（システム データとも呼ばれる）を再構築している場合、データ バッファーは少なくとも 1 つのキー仕様ブロックのサイズがあり、ゼロに初期化されている必要があります。
4. 新しいキーに ACS を定義するには、次のいずれかの手順を実行します。
• デフォルトの ACS、つまり、ファイルに既に定義されている先頭の ACS を使用するには、キー フラグ ワードに「デフォルトの ACS を使用」属性を指定します。
• 新しい ACS を定義するには、キー フラグ ワードに「番号付きの ACS を使用」属性を指定し、ACS 番号フィールドをゼロに設定します。さらに、データ バッファーの最後のキー仕様ブロックの後に 265 バイトの ACS を格納します。
• 名前によって既存の ACS を指定するには、キー フラグ ワードに「名前付きの ACS を使用」属性を指定し、ACS 番号フィールドをゼロに設定します。さらに、ACS 名を、データ バッファーの最後のキー仕様ブロックの後にある 265 バイトのブロックの先頭から格納します（名前より後の ACS ブロックの残り部分は無視されます）。名前の形式は次のいずれかに従っている必要があります。
5. データ バッファー長パラメーターをデータ バッファー内のバイト数に設定します。新しいキーが ACS を持たない、もしくはデフォルトの ACS を使用する場合は、次の式を使って正しいデータ バッファー長を決定します。
(16 または 24) * (セグメント数)
新しいキーでデフォルト以外の ACS を指定する場合は、次の式を使って正しいデータ バッファー長を決定します。
(16 または 24) * (セグメント数) + 265
6. 作成されるキーに特定のキー番号を割り当てるには、目的のキー番号に 0x80 を加算し、その合計値をキー番号パラメーターに入れます。システム キー（システム データまたはシステム データ v2 とも呼ばれる）を再構築している場合は、0xFD（つまり、キー番号 125 + 128）または 0XFC（キー番号 124 + 128）を指定します。BTRVEX では、このバイアスにより小さな正の値が生成されるため、符号拡張してはいけないということに留意してください。
メモ： キー番号はファイルで一意であることが必要です。また、有効な値でなければなりません。つまり、各キー番号の値は、指定したページ サイズに対して許容されるキー セグメントの最大数よりも小さい値でなければなりません。
詳細
MicroKernel エンジンでは、キーを作成するときに特定のキー番号を割り当てることができます。この機能は、キーを削除して、その削除したキーよりも大きなキー番号を持つすべてのキーの番号を MicroKernel エンジンに付け替えさせないようにする機能と相補関係にあります。アプリケーションがインデックスを削除し、MicroKernel エンジンにそれよりも大きな番号を持つキーの番号を付け替えないように指示を出した場合、その後でユーザーが具体的なキー番号を割り当てずに影響を受けたファイルを複製すると、複製したファイルには元のファイルとは別のキー番号が割り当てられます。
データ バッファーで ACS を定義すると、MicroKernel エンジンは ACS 定義をファイルに追加する前に、まず指定された名前を使って既存の ACS をチェックします。MicroKernel エンジンが指定された名前を持つ既存の ACS を検出した場合、MicroKernel エンジンはファイル内で ACS 定義の複製は行わず、既存の ACS と新しいキーとの関連付けを行います。
キー フラグ ワードに「名前付きの ACS を使用」属性を指定した場合、MicroKernel エンジンはデータ バッファーに指定された ACS 名を使ってファイル内で同名の ACS を検索してから、その ACS を新しいキーに割り当てます。
ファイルが複数の MicroKernel エンジン クライアントによって開かれており、そのクライアントのうちの 1 人が Create Index プロセスを開始した場合、リモート クライアントは、MicroKernel エンジン クライアントによってキーが作成されている間も、開いているファイルに対して Get および Step オペレーションを実行できます。
作成されるキーが autoincrement キーでない場合は、リモート クライアントの Get および Step オペレーションにロック バイアスを使用でき、Create Index プロセスが完了したときに、読み取りオペレーションをさらに発行しなくても、ロックされていたレコードを更新したり削除したりできます。MicroKernel エンジンではキーを作成するためにレコードのイメージを変更する必要がないため、このような処理が可能になります。
ただし、作成されるキーが autoincrement キーである場合は、MicroKernel エンジンではインデックスを構築し、かつ適切なフィールドでゼロ値を使ってすべてのレコードを変更する必要があります。キーの作成前または最中にロック バイアスを使わずに Get または Step オペレーションを実行したリモート クライアントは、キーの作成が正常に終了した後で Update または Delete オペレーションを実行するとき、ステータス コード 80 を受け取ります。
また、あるクライアントがレコードをロックしている最中に、別のクライアントが autoincrement キーを作成しようとすると、MicroKernel エンジンからステータス コード 84 が返されます。同様に、あるクライアントが autoincrement キーのインデックスを作成している最中に、別のクライアントがロック バイアスを使って Get または Step オペレーションを実行しようとすると、MicroKernel エンジンからステータス コード 85 が返されます。
結果
MicroKernel エンジンはファイルに新しいキーを直ちに追加します。このオペレーションの所要時間は、インデックスが作成される総レコード数、ファイルのサイズおよび新しいインデックスの長さによって変わります。
Create Index オペレーションが正常に終了した場合、新しいキーの番号は指定した番号になるか、または次のいずれかになります。
• キー番号が飛んでいないファイルの場合は、新しいキー番号は以前の最大のキー番号より 1 つ大きくなります。
• キー番号が飛んでいるファイルの場合は、新しいキー番号は欠けているキー番号のうちの最小の番号になります。
オペレーションの終了次第、新しいキーを使ってデータにアクセスすることができるようになります。
Create Index オペレーションが失敗した場合、新しいインデックスの一部が既に構築されていたとしても、MicroKernel エンジンはそれをすべて削除します。エラーが発生する前に新しいインデックスに割り当てられたファイル ページは、ファイルの空き領域リストに置かれ、レコードを挿入したり別のキーを作成したりするときに再利用されます。
autoincrement キーの作成中にオペレーションが失敗した場合、それまでに変更されている値はそのまま残ります。MicroKernel エンジンから返される可能性のあるステータス コードは次のとおりです。
キーの作成中に処理が中断されても、ファイル内のほかのキーを使ってファイルのデータにアクセスすることはできます。しかし、不完全なインデックスを使ってデータにアクセスしようとすると、MicroKernel エンジンから 0 以外のステータス コードが返されます。この問題を解決するには、Drop Index（32）オペレーションを使って不完全なインデックスを削除し、Create Index を再発行してください。
ポジショニング
Create Index オペレーションは、ファイルのカレンシー情報にまったく影響しません。
Delete（4）
Delete オペレーション（B_DELETE）では、ファイルから既存のレコードを削除します。削除したレコードが占有していたスペースは、新しいレコードを挿入するために再利用されます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• 対象となるファイルの物理カレンシーまたは論理カレンシーを確立しておくことが必要です。この要件を満たすオペレーションには、Get（Get ... Extended、Get Key を除く）、Step（Step ... Extended を除く）、Insert、および Update オペレーションがあります。
手順
1. オペレーション コードを 4 に設定します。
2. 削除するレコードを含むファイルのポジション ブロックを渡します。
詳細
Delete オペレーションは、Extended Get または Extended Step オペレーションの直後に実行した場合には現在のレコードが予測不能であるため、有効なオペレーションにならない可能性があります。
Delete オペレーションを実行した後、それ以降の Get Next または Get Previous オペレーションでは、論理位置を確立した直前のオペレーションと同じキー番号およびキー バッファーを使用する必要があります。別の値を使用すると、MicroKernel エンジンからステータス コード 7 が返されます。
MicroKernel エンジンでは、Get Key（+50）の後に Delete オペレーションを実行することはできません。MicroKernel エンジンで Delete オペレーションを実行する前に、変更しようとしているデータ ページの現在の使用回数と、レコードを読み取った時点のデータ ページの使用回数が比較されます。使用回数を取得するには、MicroKernel エンジンがデータ ページを読み取る必要があります。
Get Key オペレーションではデータ ページを読み取らないので、Delete オペレーションで比較するための使用回数が利用可能になりません。MicroKernel エンジンでは、比較なしにパッシブ並行制御の矛盾チェックを実行できないため、Delete オペレーションは正常に実行されません。Delete オペレーションが正常に実行されないと、MicroKernel エンジンからステータス コード 8 が返されます。
結果
Delete オペレーションが正常に終了した場合は、MicroKernel エンジンによってファイルからレコードが削除され、削除したレコードにロックが設定されていた場合はそのロックが解除され、さらに削除の結果を反映して、すべてのキー インデックスを調整されます。
Delete オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
Delete オペレーションを実行してもファイル サイズは小さくなりません。レコードの削除によって生じる空き領域は、今後レコードを追加するときに再利用されます。ディスク容量を回復するには、ファイルを再作成して、そのファイルにすべてのレコードを挿入するしかありません。Rebuild および Defragmenter ユーティリティが、この回復を実現するのに役立ちます。
ポジショニング
Delete オペレーションを実行すると、すべての物理位置情報と現在のレコードの論理位置は消去されますが、次のレコードまたは前のレコードの論理位置は変わりません。
Drop Index（32）
Drop Index オペレーション（B_DROP_INDEX）では、既存のファイルからキーを削除します。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイル内にキーが存在していることが必要です。
• トランザクションが実行中でないことが必要です。
手順
1. オペレーション コードを 32 に設定します。
2. 削除するキーを含むファイルのポジション ブロックを渡します。
3. キー番号パラメーターに削除するキーの番号を格納します。システム定義のログ キー（システム データとも呼ばれる）を削除するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを削除するには、124 を指定します。
詳細
システム キーを削除した場合、Create Index（31）オペレーションを使ってそれを再構築することができます。
キーを削除する場合、特に指定しなければ、削除したキーよりもキー番号の大きなキーはすべて、MicroKernel エンジンによって自動的に番号が付け替えられます。MicroKernel エンジンは、削除したキーよりも番号の大きなキーの番号を 1 ずつ減らします。たとえば、キー番号 1、4、および 7 を含むファイルがあるとします。キー 4 を削除すると、MicroKernel エンジンは残ったキーの番号を 1 と 6 に付け替えます。
MicroKernel エンジンによってキー番号を自動的に付け替えられたくない場合は、128 というバイアスをキー番号パラメーターに入れる値に加算します。このバイアスにより、キー番号は飛んだままにしておくことができ、その結果、ファイル内のほかのキー番号に影響を及ぼすことなく、壊れたインデックスを削除し、そのインデックスを作成し直すことができます。インデックスを再構築するには、Create Index（31）を使います。このオペレーションではキー番号を指定できます。
ただし、キーを削除し、それよりキー番号の大きなキーの番号を付け替えなかった場合、その後でユーザーが具体的なキー番号を割り当てずに影響を受けたファイルを複製すると、複製したファイルには元のファイルとは別のキー番号が割り当てられます。
メモ： ユーザーは Btrieve Maintenance ツール、またはそのコマンド ライン バージョンの butil を使ってファイルを複製できます。複製により、既存のファイルと同じ統計情報を持つ新しい空のファイルが作成されます。
結果
Drop Index オペレーションが正常に終了した場合、指定したインデックスは MicroKernel エンジンによって削除され、そのインデックスに割り当てられていたページは、今後の使用のために空き領域のリストに配置されます。また、特に指定しなければ、MicroKernel エンジンでは削除したキーよりもキー番号の大きなキーの番号が付け替えられます。
Drop Index オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
MicroKernel エンジンがインデックスを削除中に処理が中断されても、ファイル内のほかのキーを使ってファイルのデータにアクセスすることはできます。しかし、不完全なインデックスを使ってファイルにアクセスしようとすると、MicroKernel エンジンからステータス コード 56 が返されます。処理が中断された場合は、Drop Index オペレーションを再発行してください。
ポジショニング
Drop Index オペレーションは、ファイルの物理カレンシー情報にはまったく影響しません。ただし、直前に論理カレンシーを確立するために使用したキーを削除すると、論理カレンシーは消去されます。
End Transaction（20）
End Transaction オペレーション（B_END_TRAN）では、トランザクションを終了し、データ ファイルに適切な変更を加えます。また、トランザクションによって設定されたすべてのファイルとレコードのロックを解除します。
パラメーター
前提条件
End Transaction オペレーションを発行する前に、Begin Transaction（19 または 1019）が正常に終了している必要があります。
手順
オペレーション コードを 20 に設定します。MicroKernel エンジンでは、オペレーション コード以外の End Transaction 呼び出しパラメーターはすべて無視されますが、将来のリリースとの互換性を確保するために 0 に初期化してください。
結果
End Transaction オペレーションが正常に終了した場合は、トランザクション内で実行されたすべてのオペレーションの結果がファイルに保存されます。End Transaction オペレーションを実行した後でトランザクションを中止することはできません。
End Transaction オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードが返されます。
ポジショニング
End Transaction オペレーションは、ファイルのカレンシー情報にまったく影響しません。
Find Percentage（45）
Find Percentage オペレーション（B_GET_PERCENT）は、スクロール バーを実装するウィンドウ指向のアプリケーションで使用することのできる 2 つの Btrieve API オペレーションのうちの 1 つです。もう 1 つのオペレーションは Get By Percentage（44）です。Find Percentage では、キー パスまたはファイル内でのレコードの物理位置を基準として、それに対応するレコードのおおよその位置を返します。位置はパーセンテージ値で表されます。パーセンテージ値の範囲の定義については、
結果を参照してください。
パラメーター
メモ： Find Percentage を使って、キー パスを基準に対応するパーセンテージをシークする場合は、データ バッファー パラメーターに値を入力する必要はありません。ファイル内のレコードの物理位置を基準にしてパーセンテージをシークする場合は、キー バッファー パラメーターに値を入力する必要はありません。
前提条件
• 対象となるファイルが開いていることが必要です。
• キー パスに基づいてパーセンテージをシークする場合は、対象となるファイルがデータオンリー ファイルであってはいけません。
• ファイル内のレコードの物理位置に基づいてパーセンテージをシークする場合は、その物理位置をデータ バッファー パラメーターに指定する必要があります。この位置は、Get Position（22）を使って取得できます。BTRV または BTRVEX タイプのエントリ ポイントの使用と一貫性を持たせてください。
手順
1. オペレーション コードを 45 に設定します。
2. ファイルのポジション ブロックを渡します。
3. ファイル内のレコードの物理位置を基準にしてパーセンテージをシークする場合は、レコードの 4 バイトまたは 8 バイトの物理アドレスをデータ バッファーに格納します。レコードのキー パスを基準にしてパーセンテージをシークし、その検索の精度を指定する場合は、
精度で指定されているようにデータ バッファー パラメーターを設定します。それ以外の場合は、データ バッファー パラメーターに値を入れる必要はありません。
4. データ バッファー長を最小値である 4 バイトまたは 8 バイトに設定します。この 4 バイトという最小長は、MicroKernel エンジンの内部的な実装に必要とされます。検索の精度を指定する場合は、データ バッファー長を最小値の 12 バイトまたは 16 バイトに設定します。
5. キー パスを基準にパーセンテージをシークする場合は、キー バッファー パラメーターをキー値に設定します。それ以外の場合は、キー バッファー パラメーターに値を入れる必要はありません。
6. キー番号パラメーターを以下のとおりに設定します。
• キー パスによってパーセンテージをシークする場合は、キー番号パラメーターを実際のキー番号に設定します。
• レコードの物理位置によってパーセンテージをシークする場合は、キー番号パラメーターを -1 に設定します。
詳細
Find Percentage オペレーションは、特にスクロール バーの実装をサポートする目的で用意されています。このオペレーションの精度、つまり、返されたパーセンテージ値がレコードまたはキー値の位置をどれだけ精確に反映しているかどうかは、さまざまな要因によって影響を受けます。このため、スクロール バーの実装以外の目的で使用する場合は、このオペレーションの精度を信頼しないでください。
Find Percentage オペレーションを最適化するため、MicroKernel エンジンでは、ファイルのレコードはデータ ページ間に、キーはインデックス ページ間に均等に分布していることを前提としています。ただし、分布状態は次のような状況によって影響を受けます。
• ファイルがインデックス バランスを使用しておらず、同一範囲内のキーで多数のレコードが削除されている。
• 同一範囲内の物理アドレスで多数のレコードが削除されている。
• ファイルに多数の重複するキー値が含まれており、そのキーがリンク重複キーになっている。
精度
精度の設定は任意であり、パーセンテージを測定する要素を選択することができます。Zen 9 より前のリリースでは、この値は常に 10000 でした。
精度を指定する場合は、以下の手順に従ってください。
Find Percentage オペレーションの精度を指定するには
1. データ バッファーのレコード アドレス領域の後の 4 バイトに識別バイト ExPc（0x45、0x78、0x50、0x63）を設定します。
2. この識別バイトの後の 4 バイトに希望する精度を LoHi Intel 整数で指定します。選択できる精度は、1 から 0xFFFFFFFF までの数値です。
3. 使用されるエントリ ポイントに応じて、データ バッファー長が少なくとも 12 バイトまたは 16 バイトであることを確認してください。
次の表は、これらの手順における位置とレイアウトをまとめています。
たとえば、365 件のレコードが入っているファイルから 100 番目のレコードを取得したい場合、パーセンテージに 100、精度に 365 を使用して Find Percentage（45）を実行することができます。
結果
Find Percentage オペレーションが正常に終了した場合は、MicroKernel エンジンによって、指定したキー値またはレコードの相対位置がデータ バッファーに返されます。この位置は、キー パスまたはファイルにおけるオフセットのパーセンテージとして表され、0（0%）から 10000（100.00%）までの範囲の値になります。これは、物理位置でも論理位置でもないので注意してください。
パーセンテージ値は、下位バイト、上位バイトの順の 4 バイト整数として返されます。たとえば、デフォルトの精度を使用する場合は次のようになります。
また、オペレーションが正常に終了した場合には、MicroKernel エンジンからデータ バッファー長に少なくとも 4 が返されます。
Find Percentage オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Find Percentage オペレーションを実行しても、カレンシー情報は変更されません。
Get By Percentage（44）
Get By Percentage オペレーション（B_SEEK_PERCENT）は、スクロール バーを実装するウィンドウ指向のアプリケーションで使用することのできる 2 つの Btrieve API オペレーションのうちの 1 つです。もう 1 つは
Find Percentage（45）です。Get By Percentage オペレーションは、ファイル内のレコードの相対位置によってレコードを取得します。この位置は、オペレーションを呼び出すときに指定したパーセンテージ値に基づきます。また、この位置は特定のキー パスを基準とするのか、ファイル内のレコードの実際の物理位置を表すのかを指定する必要があります。
パラメーター
メモ： ファイル内のレコードの物理位置を基準としてレコードをシークする場合、Get By Percentage オペレーションからキー バッファー パラメーターには何の情報も返されません。
前提条件
• 対象となるファイルが開いていることが必要です。
• キー パスに基づいてレコードをシークする場合は、対象となるファイルがデータオンリー ファイルであってはいけません。
手順
1. オペレーション コードを 44 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. パーセンテージの値を 4 バイト整数でデータ バッファーに格納します。パーセンテージ値の許容範囲および関連情報については、
詳細を参照してください。
4. データ バッファー長を、返される可能性のある最大レコード長以上の値に設定します（MicroKernel エンジンの内部的な実装は、データ バッファー長が最小値の 4 バイトに設定されていることを必要とします）。検索に精度を設定する場合は、データ バッファー長を最小値の 12 バイトに設定します。
5. キー番号パラメーターを設定します。
• キー パスによってパーセンテージをシークする場合は、キー番号パラメーターを実際のキー番号に設定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
• ファイル内のレコードの物理位置によってレコードをシークする場合は、キー番号パラメーターを -1 に設定します。
詳細
精度を指定しない場合（
精度を参照）、データ バッファー パラメーターの最初の 2 バイトに対するパーセンテージ値の許容範囲は、0（キー パスまたはファイルの先頭を表します）から 10000（キー パスまたはファイルの末尾を表します）までです。この値は、小数点以下 2 桁を含むものとして、0% から 100.00% の範囲に対応しています。ファイル中の 33.33% あたりにあるレコードを検索する場合は、データ バッファーに値 3333 を渡します。値は、下位バイト、上位バイトの順の整数として格納してください。たとえば、ファイル内の 50% の地点をシークするには、5000（0x1388）という値を使います。0x1388 の下位バイトと上位バイトを入れ替え、0x88 と 0x13 をデータ バッファー パラメーターの先頭の 2 バイトに格納します。
検索の精度を指定する場合は、
精度で指定されているようにデータ バッファー パラメーターを設定します。
Get By Percentage オペレーションは、特にスクロール バーの実装をサポートする目的で用意されています。このオペレーションの精度、つまり、返されたレコードがファイル内の指定したパーセンテージ地点に実際に位置しているかどうかは、さまざまな要因によって影響を受けます。このため、スクロール バーの実装以外の目的で使用する場合は、このオペレーションの精度を信頼しないでください。
Get By Percentage オペレーションを最適化するため、MicroKernel エンジンでは、ファイルのレコードはデータ ページ間に、キーはインデックス ページ間に均等に分布していることを前提としています。ただし、分布状態は次のような状況によって影響を受けます。
• ファイルがインデックス バランスを使用しておらず、同一範囲内のキーで多数のレコードが削除されている。
• 同一範囲内の物理アドレスで多数のレコードが削除されている。
• ファイルに多数の重複するキー値が含まれており、そのキーがリンク重複キーになっている。
精度
精度の設定は任意であり、パーセンテージを測定する要素を選択することができます。Zen 9 より前のリリースでは、この値は常に 10000 でした。
精度を指定する場合は、以下の手順に従ってください。
Get By Percentage オペレーションの精度を指定するには
1. データ バッファーのパーセンテージの後の 2 番目の 4 バイトに識別バイト ExPc（0x45、0x78、0x50、0x63）を設定します。
2. この識別バイトの後の 4 バイトに希望する精度を LoHi Intel 整数で指定します。選択できる精度は、1 から 0xFFFFFFFF までの数値です。
3. データ バッファー長が少なくとも 12 バイトあることを確認してください。
たとえば、365 件のレコードが入っているファイルから 100 番目のレコードを取得したい場合、パーセンテージに 100、精度に 365 を使用して Get By Percentage（44）を実行することができます。
結果
Get By Percentage オペレーションが正常に終了した場合は、MicroKernel エンジンによって、指定したキー パスを基準とする位置またはファイル内の物理位置にあるレコードがデータ バッファーに返されます。さらに MicroKernel エンジンからは、データ バッファー長パラメーターにレコード長がバイト単位で返されます。キー パスによってレコードをシークした場合は、MicroKernel エンジンからキー バッファー パラメーターに指定したキー パスのキー値が返されます。物理レコード順によってレコードをシークした場合は、MicroKernel エンジンからキー バッファー パラメーターには何の情報も返されません。
メモ： Get By Percentage オペレーションでキー パスを基準としてレコードをシークした場合、そのキーに重複値が含まれているときは、MicroKernel エンジンでは常に重複値を含む先頭のレコードが返されます。このような実装の細部によって、オペレーションの精度が影響を受ける場合があります。
Get By Percentage オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
指定したキー パスを基準にしてレコードをシークするとき、Get By Percentage オペレーションが正常に終了した場合は、指定したキー番号と取得したレコードのそれぞれに基づいて新しい論理カレンシーおよび物理カレンシーが確立されます。
ファイル内のレコードの物理位置を基準にしてレコードをシークするとき、Get By Percentage オペレーションが正常に終了した場合は、取得したレコードに基づいて新しい物理カレンシーが確立されます。
Get By Percentage オペレーションが失敗した場合、MicroKernel エンジンではカレンシーは変更されません。
Get Direct/Chunk（23）
Get Direct/Chunk オペレーション（B_GET_DIRECT）では、チャンクと呼ばれるレコードの部分を 1 つまたは複数取得できます。このオペレーションは、最大データ バッファー サイズより長いレコードを含むファイルで特に役に立ちます。データ バッファー パラメーターの長さには制限があるため、このようなレコードは長すぎて、ほかの Get および Step オペレーションでは取得できません。アプリケーションでは、物理アドレスを指定することで、チャンクが取得されるレコードを指定します。通常、レコード内でのチャンクの位置は、そのオフセットと長さで指定されます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• レコードの物理位置を用意する必要があります。この位置は、Get Position（22）を使って取得できます。BTRV または BTRVEX タイプのエントリ ポイントの使用と一貫性を持たせてください。
• Get Direct/Chunk オペレーションから返されるすべての値を格納するのに十分な大きさのデータ バッファーを用意する必要があります。また、Get Direct/Chunk オペレーションが間接チャンク オペレーションを実行するとき、データ バッファーにはチャンク ディスクリプター全体（すべてのチャンク定義）を格納できなければなりません。
手順
1. オペレーション コードを 23 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. 詳細の説明に従って、データ バッファーを指定します。
4. データ バッファー長には、入力構造体の長さと MicroKernel エンジンに取得するように要求したバイト数のどちらか大きい方を指定します。
Get Direct/Chunk オペレーションの一部のオプションでは、データ バッファー以外の場所にチャンクを取得します。データ バッファー長の計算の詳細については、
詳細を参照してください。
5. キー番号パラメーターを -2 に設定します。
詳細
データ バッファーでは、次のチャンク ディスクリプターのいずれかを使用します。
• ランダム チャンク ディスクリプター - オペレーションに付き 1 つのチャンクを取得するため、またはチャンクがレコード全体にわたってランダムに配置されているときに、1 回のオペレーションで複数のチャンクを取得するために使用します。
• 矩形チャンク ディスクリプター - 各チャンクの長さが同じで、チャンクがレコード内に等間隔に配置されているときに、1 回のオペレーションで複数のチャンクを取得するために使用します。
ランダム チャンク
次の例は、ランダムに配置されている 3 つのチャンク（[*] がある部分）を含むレコードを示しています。チャンク 0（バイト 0x12 から 0x16）、チャンク 1（バイト 0x2A から 0x31）、およびチャンク 2（バイト 0x41 から 0x4E）です。
ランダム チャンク オペレーションのデータ バッファー
ランダム チャンクを取り出すには、次の表に基づいてデータ バッファー内に構造体を作成する必要があります。
次の表は、BTRV エントリ ポイントを使って直接ランダム チャンクを取り出す場合の、32 ビット アプリケーション用データ バッファーの例を示しています。
矩形チャンク ディスクリプター構造体
同じ長さのチャンクがレコード全体にわたって等間隔に配置されている場合は、矩形チャンク ディスクリプターを使って、取得するすべてのチャンクを記述することができます。たとえば、次のような図を考えてみましょう。この図は、レコード内のオフセット 0x00 から 0x4F までを表しています。
このレコードには 3 つのチャンク（[*] がある部分）が含まれています。チャンク 0（バイト 0x19 から 0x1C）、チャンク 1（バイト 0x29 から 0x2C）、およびチャンク 2（バイト 0x39 から 0x3C）です。各チャンクはどれも 4 バイトの長さで、チャンク同士は、各チャンクの先頭から計算すると、いずれも合計 16（0x10）バイトずつ離れています。
矩形チャンクのデータ バッファー
1 つの矩形ディスクリプターを使って、3 つのチャンクをすべて取得できます。矩形チャンクを取り出すには、次の表に基づいてデータ バッファー内に構造体を作成する必要があります。
間接矩形ディスクリプターを使用するときは、取得されたチャンクがチャンク ディスクリプターを上書きしないように、ユーザー データ ポインターが初期化されていることを確認してください。MicroKernel エンジンはディスクリプターを使用して、返されたチャンクをユーザー データ要素で示される場所にコピーします。チャンク ディスクリプターを上書きしてしまった場合は、MicroKernel エンジンからステータス コード 62 が返されます。
矩形がメモリ内にあるとき、各行の間隔がレコードとして格納されているときと同じバイト数になる場合は、アプリケーションの行間隔を行間隔と同じ値に設定します。しかし、矩形がアプリケーション メモリ内で再配置され、行の間隔が何バイトか増減する場合は、アプリケーションの行間隔により、その情報を MicroKernel エンジンに渡すことができます。
間接矩形ディスクリプターを使用するときは、MicroKernel エンジンはユーザー データ要素およびアプリケーションの行間隔要素を使って、取得後のデータの格納場所を決定します。MicroKernel エンジンは 1 行目のデータを、ユーザー データのオフセット 0 に格納します。MicroKernel エンジンは 2 行目のデータを、ユーザー データ + アプリケーションの行間隔で指定されるアドレスに格納します。MicroKernel エンジンは 3 行目のデータを、ユーザー データ + (アプリケーションの行間隔 * 2) で指定されるアドレスに格納します。以下同様です。
次の表は、BTRV エントリ ポイントを使って直接矩形チャンクを取り出す場合の、32 ビット アプリケーション用データ バッファーの例を示しています。
ネクストインレコード サブファンクション バイアス
これまでに述べたサブファンクションの値にバイアス 0x40000000 を加算すると、MicroKernel エンジンではレコード内の物理カレンシー（つまり、レコード内の現在の物理位置）に基づいてサブファンクションのオフセット要素の値が算出されます。ネクストインレコード サブファンクションを使用する場合、MicroKernel エンジンではチャンク ディスクリプターのオフセット要素は無視されます。
結果
Get Direct/Chunk オペレーションが正常に終了した場合、直接チャンク ディスクリプターを使用しているときは、MicroKernel エンジンではデータ バッファーにチャンクが順に返されます。間接ランダム チャンク ディスクリプターを使用しているとき、MicroKernel エンジンでは各チャンクのユーザー データ要素で指定した場所にデータが返されます。また、間接矩形ディスクリプターを使用しているとき、MicroKernel エンジンではユーザー データ要素およびアプリケーションの行間隔要素から計算される場所にデータが返されます。
さらに MicroKernel エンジンから、データ バッファー長パラメーターには、取得されたチャンクの長さの総計が格納されます（この戻り値は、チャンクが取得されて直接データ バッファーに格納されたか、間接ディスクリプターによってチャンクが取得され別の場所に格納されたかどうかに関係なく、取得された全バイト数を反映しています）。オペレーションが部分的にしか正常に実行されなかった場合、アプリケーションではデータ バッファー長パラメーターに返された値を使って、どのチャンクが取得されなかったか、また最後のチャンクの何バイトまでが取得されたかを調べることができます。
いずれかのチャンクで、開始位置がレコードの末尾を超えてしまう場合（結果として、MicroKernel エンジンからステータス コード 103 が返されます）、またはチャンクのオフセットと長さの合計がレコード長を超えてしまう場合には、Get Direct/Chunk オペレーションの一部だけが正常に実行されます。後者の場合は MicroKernel エンジンからステータス コード 0 が返されますが、このオペレーションに後続のチャンクがある場合、その処理は中止されます。
メモ： すべてのチャンクが適切に取得されたかどうかを知らせるものは、データ バッファー長パラメーターだけです。このため、Get Direct/Chunk オペレーションの実行後は、必ずデータ バッファー長パラメーターに返された値をチェックしてください。
次のステータス コードは、Get Direct/Chunk オペレーションの一部だけが実行されたことを示します。MicroKernel エンジンからこれらのステータス コードのいずれかが返された場合は、アプリケーションでデータ バッファー長パラメーターの戻り値を調べて、MicroKernel エンジンから実際に返されたデータ量を確認する必要があります。
MicroKernel エンジンから次のステータス コードが返される場合、データはまったく取得されません。
ポジショニング
Get Direct/Chunk オペレーションは、論理カレンシーにまったく影響しません。物理カレンシーについては、チャンクが取り出されたレコードが現在の物理レコードになります。
Get Direct/Record（23）
Get Direct/Record オペレーション（B_GET_DIRECT）では、定義されているキー パスではなく、ファイル内の物理位置を使ってレコードを取得します。
以下のような操作を実行する場合は、Get Direct/Record オペレーションを使用してください。
• キー値の代わりに物理位置を使って、より高速にレコードを取得する。
• Get Position（22）を使ってレコードの物理位置を取得し、その位置を保存する。それから、カレンシーに影響を与えるほかのオペレーションを実行した後で Get Direct/Record を使って、その位置に直接戻る。
• 一連の重複レコードの中から 1 つのレコードを取得するとき、その一連のレコードを先頭からすべて読み取りし直すことなく、物理位置を使って取得する。
• 現在のキー パスを変更する。Get Position オペレーションに続けて、別のキー番号を使った Get Direct/Record オペレーションを実行すると、別のインデックス パスに現在のレコードのポジショニングが確立します。この後で Get Next オペレーションを実行すると、新しいキー パスに基づいてファイル内の次のレコードが返されます。
パラメーター
メモ： データオンリー ファイルで Get Direct/Record オペレーションを実行する場合は、キー番号パラメーターは必要ありません。
前提条件
• 対象となるファイルが開いていることが必要です。
• 4 バイトまたは 8 バイトから成るレコードの物理位置を用意する必要があります。この値は、Get Position（22）を使って取得できます。このオペレーションを実行すると、現在のレコードの物理アドレスが返されます。BTRV または BTRVEX タイプのエントリ ポイントの使用と一貫性を持たせてください。
手順
1. オペレーション コードを 23 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファーの先頭に、目的のレコードの位置を表す 4 バイト値または 8 バイト値を格納します。サイズは、使用しているエントリ ポイントが BTRV タイプか BTRVEX タイプかによって決まります。
4. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
5. キー番号を、MicroKernel エンジンで論理カレンシーを確立するパスのキー番号に設定します。MicroKernel エンジンで論理カレンシーの確立を必要としない場合は、-1 を指定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
結果
Get Direct/Record オペレーションが正常に終了した場合、MicroKernel エンジンでは要求したレコードがデータ バッファーに、レコード長がデータ バッファー長に、指定したキー パスのキー値がキー バッファーにそれぞれ返されます。
Get Direct/Record オペレーションが失敗し、要求したレコードを MicroKernel エンジンが取得できなかった場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Get Direct/Record オペレーションを実行すると、既存の論理カレンシー情報が消去され、指定したキー番号に従って新しい論理カレンシーが確立されます。物理カレンシー情報にはまったく影響しません。
Get Directory（18）
Get Directory オペレーション（B_GET_DIR）では、指定された論理ディスク ドライブの現在のディレクトリを返します。
パラメーター
前提条件
Get Directory オペレーションはいつでも発行することができます。キー バッファーには少なくとも 65 文字の長さが必要です。
手順
1. オペレーション コードを 18 に設定します。
2. キー番号パラメーターに論理ディスク ドライブ番号を格納します。ドライブは、A の場合は 1、B の場合は 2、というように指定します。デフォルトのドライブを使用するには 0 を指定します。
結果
MicroKernel エンジンでは、オペレーションが正常に終了した場合、バイナリ 0 で終端する現在のディレクトリがキー バッファーに返されます。
ポジショニング
Get Directory オペレーションは、ファイルのカレンシー情報にはまったく影響しません。
Get Equal（5）
Get Equal オペレーション（B_GET_EQUAL）では、キー バッファーに指定されたキー値と等しいキー値を持つレコードを取得します。キーの重複が可能な場合は、同じキー値を持つグループの中で先頭のレコード（作成順）が取得されます。
Get Key（+50）バイアスを使うと、ファイル内に値が存在するかどうかを検出することもできます。一般に、Get Key オペレーションの方が高速に処理されます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
手順
1. オペレーション コードを 5 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
4. キー バッファーに目的のキー値を指定します。キーが複数のセグメントから成る場合は、必ずすべてのセグメントを記述し、それらすべてに値を設定するようキー バッファーを定義してください。すべてのセグメントについて検索条件を設定しない場合は、代わりに Get Greater Than Or Equal オペレーションを使用してください。
5. キー番号を正しいキー パスに設定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
結果
Get Equal オペレーションが正常に終了した場合は、MicroKernel エンジンでは要求したレコードがデータ バッファーに、そのレコードの長さがデータ バッファー長に返されます。
Get Equal オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
このオペレーションは、キーのヌル インジケーター セグメントにゼロ以外の値が含まれている場合にはステータス コード 4 を返します。Get Equal を使ってヌルのレコードは検索できません。これは、ヌルの定義はあいまいなものであり、どの値とも等しくならないからです。ヌル値の検索が必要な場合は、Get First オペレーションに続けて Get Next オペレーションを使用します。
ポジショニング
Get Equal オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、取得したレコードが現在のレコードになります。
Get First（12）
Get First オペレーション（B_GET_FIRST）では、指定されたキーに基づいて先頭の論理レコードを取得します。
Get Key（+50）バイアスを使うと、ファイル内に値が存在するかどうかを検出することもできます。一般に、Get Key オペレーションの方が高速に処理されます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
手順
1. オペレーション コードを 12 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
4. キー番号をキー パスに設定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
結果
Get First オペレーションが正常に終了した場合は、MicroKernel エンジンでは要求したレコードがデータ バッファーに返され、対応するキー値がキー バッファーに格納され、さらにそのレコードの長さがデータ バッファー長に返されます。
Get First オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Get First オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、取得したレコードが現在のレコードになります。論理位置の直前は、ファイルの先頭よりも前を指すことになります。
Get Greater Than（8）
Get Greater Than オペレーション（B_GET_GT）では、キー番号で指定されたフィールドが、キー バッファーの値よりも次に大きな値を含むレコードを取得します。キーの重複が可能な場合は、同じキー値を持つグループの中で先頭のレコード（作成順）が取得されます。
Get Key（+50）バイアスを使うと、ファイル内に値が存在するかどうかを検出することもできます。一般に、Get Key オペレーションの方が高速に処理されます。
メモ： 降順キーで Get Greater Than オペレーションを実行する場合、「次に大きな値」というのは、実際にはキー バッファーで指定された値よりも小さな値を指すことになります。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
手順
1. オペレーション コードを 8 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
4. キー バッファー パラメーターに目的のキー値を指定します。
5. キー番号パラメーターを正しいキー パスに設定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
結果
Get Greater Than オペレーションが正常に終了した場合、MicroKernel エンジンでは要求したレコードがデータ バッファーに、キー値がキー バッファーに、さらにそのレコードの長さがデータ バッファー長に格納されます。
Get Greater Than オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Get Greater Than オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、取得したレコードが現在のレコードになります。
Get Greater Than or Equal（9）
Get Greater Than or Equal オペレーション（B_GET_GE）では、キー番号で指定されたキーが、キー バッファーに指定された値と等しいかそれよりも大きな値を持つレコードを取得します。MicroKernel エンジンではまず、等しいという条件を満たすレコードが検索されます。キーの重複が可能な場合は、同じキー値を持つグループの中で先頭のレコード（作成順）が取得されます。
Get Key（+50）バイアスを使うと、ファイル内に値が存在するかどうかを検出することもできます。一般に、Get Key オペレーションの方が高速に処理されます。
メモ： 降順キーで Get Greater Than or Equal オペレーションを実行する場合、「次に大きな値」というのは、実際にはキー バッファーで指定された値よりも小さな値を指すことになります。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
手順
1. オペレーション コードを 9 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
4. キー バッファー パラメーターにキー値を指定します。
5. キー番号パラメーターを正しいキー パスに設定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
結果
Get Greater Than or Equal オペレーションが正常に終了した場合、MicroKernel エンジンでは要求したレコードがデータ バッファーに、キー値がキー バッファーに、さらにそのレコードの長さがデータ バッファー長に格納されます。
Get Greater Than or Equal オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Get Greater Than or Equal オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、取得したレコードが現在のレコードになります。
Get Key（+50）
Get Key バイアスを使用すると、実際にデータ レコードを取得することなく Get オペレーションを実行できます。Get Key を使って、ファイル内にある値が存在するかどうかを検出できます。一般に、Get Key オペレーションは対応する Get オペレーションよりも高速に実行できます。Get Key オペレーションは、以下のいずれかの Get オペレーションと共に使用します。
パラメーター
パラメーターは対応する Get オペレーションと同様です。ただし、MicroKernel エンジンではデータ バッファー長の設定は無視され、データ バッファーにはレコードが返されません。
前提条件
Get Key オペレーションの前提条件は、対応する Get オペレーションの前提条件と同じです。
手順
1. 対応する Get オペレーションの場合と同じようにパラメーターを設定します。データ バッファー長を初期化する必要はありません。
2. オペレーション コードを、実行する Get オペレーションのオペレーション コードに 50 を加算した値に設定します。たとえば、Get Equal（5）と共に Get Key（+50）を実行するには、オペレーション コードを 55 に設定します。
MicroKernel エンジンでは、Get Key（+50）の後に Delete または Update オペレーションを実行することはできません。MicroKernel エンジンで、Delete または Update オペレーションを実行する前に、変更しようとしているデータ ページの現在の使用回数と、レコードを読み取った時点のデータ ページの使用回数が比較されます。使用回数を取得するには、MicroKernel エンジンがデータ ページを読み取る必要があります。
Get Key オペレーションではデータ ページを読み取らないので、Delete または Update オペレーションで比較するための使用回数が利用可能になりません。MicroKernel エンジンでは、比較なしにパッシブ並行制御の矛盾チェックを実行できないため、Update または Delete オペレーションは正常に実行されません。Update または Delete オペレーションが正常に実行されないと、MicroKernel エンジンからステータス コード 8 が返されます。
結果
MicroKernel エンジンで要求したキーが検出されると、そのキー値がキー バッファーに格納され、ステータス コード 0 が返されます。そうでない場合は、MicroKernel エンジンからキー値を検出できなかった理由を示すステータス コードが返されます。
ポジショニング
Get Key オペレーションを実行すると、対応する Get オペレーションと同様の方法で現在のポジショニングが確立されます。ただし、Get Key オペレーションの対象となるキーが重複を許可している場合、MicroKernel エンジンでは取得された現在のキー値の重複インスタンスは無視されます。Get Key オペレーションの実行後、論理位置の直前は次に小さなキー値を含むレコードを指します。また、論理位置の直後は次に大きなキー値を含むレコードを指します。
たとえば、Smith が 8 回と Smythe が 1 回出現する姓のキーを対象に、Get Key を Get Equalオペレーション（55）と共に実行したとします。論理位置の直後は次の Smith ではなく、Smythe を指すことになります。
Get Key オペレーションではどれか 1 つのレコードが識別されるわけではないため、MicroKernel エンジンでは Get Key オペレーションに続けて Update または Delete オペレーションを実行することはできません。
Get Last（13）
Get Last オペレーション（B_GET_LAST）では、指定されたキーに基づいて末尾の論理レコードを取得します。末尾のキー値が重複している場合は、同じキー値を持つグループの中で末尾のレコードが返されます。
Get Key（+50）バイアスを使うと、ファイル内に値が存在するかどうかを検出することもできます。一般に、Get Key オペレーションの方が高速に処理されます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
手順
1. オペレーション コードを 13 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
4. キー番号をキー パスに設定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
結果
Get Last オペレーションが正常に終了した場合は、MicroKernel エンジンでは要求したレコードがデータ バッファーに返され、対応するキー値がキー バッファーに格納され、さらにそのレコードの長さがデータ バッファー長に返されます。
Get Last オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Get Last オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、取得したレコードが現在のレコードになります。論理位置の直後は、ファイルの末尾よりも後を指すことになります。
Get Less Than（10）
Get Less Than オペレーション（B_GET_LT）では、キー番号で指定されたキーが、キー バッファーに指定された値よりも次に小さな値を持つレコードを取得します。キーの重複が可能な場合は、同じキー値を持つグループの中で末尾のレコード（作成順）が取得されます。
Get Key（+50）バイアスを使うと、ファイル内に値が存在するかどうかを検出することもできます。一般に、Get Key オペレーションの方が高速に処理されます。
メモ： 降順キーで Get Less Than オペレーションを実行する場合、「次に小さな値」というのは、実際にはキー バッファーで指定された値よりも大きな値を指すことになります。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
手順
1. オペレーション コードを 10 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
4. キー バッファー パラメーターに目的のキー値を指定します。
5. キー番号パラメーターをキー パスに設定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
結果
Get Less Than オペレーションが正常に終了した場合、MicroKernel エンジンではレコードがデータ バッファーに、そのレコードのキー値がキー バッファーに、さらにそのレコードの長さがデータ バッファー長に返されます。
Get Less Than オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Get Less Than オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、取得したレコードが現在のレコードになります。
Get Less Than or Equal（11）
Get Less Than or Equal オペレーション（B_GET_LE）では、キー番号で指定されたキーが、キー バッファーに指定された値と等しいかそれよりも小さな値を持つレコードを取得します。MicroKernel エンジンではまず、等しいという条件を満たすレコードが検索されます。キーの重複が可能な場合は、同じキー値を持つグループの中で末尾のレコード（作成順）が取得されます。
Get Key（+50）バイアスを使うと、ファイル内に値が存在するかどうかを検出することもできます。一般に、Get Key オペレーションの方が高速に処理されます。
メモ： 降順キーで Get Less Than or Equal オペレーションを実行する場合、「次に小さな値」というのは、実際にはキー バッファーで指定された値よりも大きな値を指すことになります。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
手順
1. オペレーション コードを 11 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
4. キー バッファー パラメーターにキー値を指定します。
5. キー番号パラメーターをキー パスに設定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
結果
Get Less Than or Equal オペレーションが正常に終了した場合、MicroKernel エンジンではレコードがデータ バッファーに、そのレコードのキー値がキー バッファーに、さらにそのレコードの長さがデータ バッファー長に返されます。
Get Less Than or Equal オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Get Less Than or Equal オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、取得したレコードが現在のレコードになります。
Get Next（6）
Get Next オペレーション（B_GET_NEXT）では、指定されたキーに基づいて、論理位置で次にあるレコードを取得します。Get Next オペレーションを使うと、重複するキー値を持つレコードのグループの中でレコードを検索できます。
Get Key（+50）バイアスを使うと、ファイル内に値が存在するかどうかを検出することもできます。一般に、Get Key オペレーションの方が高速に処理されます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
• アプリケーションでは、指定したキーに基づく次の論理位置を確立しておくことが必要です。
手順
1. オペレーション コードを 6 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
4. キー バッファーに、論理位置を確立した前のオペレーションで取得したキー値を指定します。
キー バッファーには、前の呼び出しで MicroKernel エンジンから返されたキー値とまったく同じものを渡します。ここに格納された情報が、ファイル内の現在の位置を決定するために必要となるからです。
5. キー番号パラメーターを、論理位置を確立した前の呼び出しで使用したキー パスに設定します。Get Next オペレーションを使ってキー パスを変更することはできません。
結果
Get Next オペレーションが正常に終了した場合、MicroKernel エンジンではレコードがデータ バッファーに、そのレコードのキー値がキー バッファーに、さらにそのレコードの長さがデータ バッファー長に返されます。
Get Next オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
このオペレーションの実行により、論理位置の直後がファイルの末尾よりも後を指す場合は、ステータス コード 9 が返されます。
ポジショニング
Get Next オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、取得したレコードが現在のレコードになります。
Get Next Delete Extended（85）
Get Next Delete Extended オペレーション（B_GET_NEXT_EXT_DELETE）では、指定されたキーに基づき、論理位置の直後からファイルの末尾へ向かって 1 つまたは複数のレコードを検索します。検索したレコードをフィルター条件と比較し、条件に一致するレコードを削除します。フィルター条件は論理式の形を取り、キー フィールドに限定されません。
このトピックで述べるように、このオペレーションが使用する入力および出力バッファー構造体、および返す結果は、
Get Next Extended（36）に記載されているものと同じです。詳細については、当該オペレーションを参照してください。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
• 指定したキーに基づく次の論理位置を確立しておくことが必要です。論理位置は、Get Equal など非拡張の（Extended でない）Get オペレーションをどれか発行することによって確立できます。
手順
1. オペレーション コードを 85 に設定します。
デフォルトでは、ロック バイアスはノーウェイトで、どのロック バイアス設定も無視されます。動作は +500 と同じです。エンジンは、ロックされたレコードを削除できない場合には、オペレーションを再試行しないで直ちに戻ります。
2. ファイルのポジション ブロックを渡します。
3. 入力構造体と戻り出力のどちらか大きい方を格納できるように、データ バッファーを指定します。
Get Next Extended（36）にある Extended オペレーションの入力バッファーの情報に従って、データ バッファーを初期化します。
5. キー バッファーに、論理位置を確立した前のオペレーションで取得したキー値を指定します。
キー バッファーには、前の呼び出しで MicroKernel エンジンから返されたキー値とまったく同じものを渡します。ここに格納された情報が、ファイル内の現在の位置を決定するために必要となるからです。
6. キー番号パラメーターを、論理位置を確立した前の呼び出しで使用したキー パスに設定します。Get Next Delete Extended オペレーションを使ってキー パスを変更することはできません。
詳細
Get Next Extended（36）の以下のトピックで、Extended オペレーションの入力バッファーの構造体とそのフィルター セグメントの使用について、さらに結果を返す出力バッファーの構造体について説明されています。
結果
Get Next Delete Extended オペレーションが正常に終了した場合は、MicroKernel エンジンから次の情報が返されます。
• 出力バッファー長には、受け取った総バイト数が格納されます。
• キー バッファーには、検索された最後のデータ レコードのキー値が格納されます。
Get Next Delete Extended オペレーションは、ほかの Step Extended および Get Extended オペレーションと同じ原因で失敗する可能性があり、次のいずれか 1 つが返されます。
出力バッファーの長さがゼロの場合、レコードは削除されていません。ただし、オペレーションが失敗する前に一部のレコードを正常に削除している可能性があります。以下に、このような一部成功のいくつかの例を示します。
• フィルター条件に一致する現在のレコードのレコード アドレスを書き出すためのスペースが出力バッファーにありません。そのレコードは削除されず、オペレーションはステータス コード 22 で失敗します。
• 別のクライアントが現在のレコードをロックしている場合、オペレーションはステータス コード 84 で失敗します。
このような場合、出力バッファー長はゼロより大きく、バッファーの最初の 2 バイトは削除されたレコード数のカウントを提供します。
MicroKernel エンジンではフィルター条件で使用するフィールドと演算子によって、要求を最適化できる場合があります。拒否レコードに達すると、ステータス コード 64 が返され、ファイルの未検索の部分にはフィルター条件を満たすレコードがそれ以上ないことが示されます。
ポジショニング
Get Next Delete Extended オペレーションでは、カレンシーは確立しません。ただし、Get Next オペレーションまたは Get Previous オペレーションを実行することができ、次または前の論理位置は有効です。また、Get Position（22）および Get Direct/Record（23）を使用することにより、有効な現在の位置も使用可能になります。
次のリストは、選定されたステータス コードとフィルター条件の関係を示しています。
• ステータス 60（リジェクト カウントに達しました）：現在の位置は、フィルター条件に一致しないレコードです。
• ステータス 64（フィルター制限に達しました）：現在の位置は、フィルター条件に一致しない可能性のあるレコードです。次のレコードに進もうとしても、フィルター条件に一致しません。
• ステータス 84（レコードまたはページはロックされています）：現在の位置は、フィルター条件に一致しない可能性のあるレコードです。また、次のレコードはフィルター条件に一致するが、ロックされているために削除できないという可能性もあります。
• ステータス 22（データ バッファーがいっぱいです）：現在の位置は、フィルター条件に一致するレコードです。ただし、データ バッファーにはレコード アドレスを書き込むためのスペースがないため、MicroKernel エンジンはそのレコードを削除しませんでした。
• ステータス 9（ファイルの終わり）：現在の位置は、論理的にも物理的にも無効です。
Get Next Extended（36）
Get Next Extended オペレーション（B_GET_NEXT_EXTENDED）では、指定されたキーに基づき、論理位置の直後からファイルの末尾へ向かって 1 つまたは複数のレコードを検索します。検索したレコードをフィルター条件と比較し、条件に一致するレコードを取得します。フィルター条件は論理式の形を取り、キー フィールドに限定されません。
Get Next Extended オペレーションでは、レコードから指定した部分だけを抽出し、その部分だけをアプリケーションに返すこともできます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
• 指定したキーに基づく次の論理位置を確立しておくことが必要です。論理位置は、Get Equal など非拡張の（Extended でない）Get オペレーションをどれか発行することによって確立できます。
手順
1. オペレーション コードを 36 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. 入力構造体と戻り出力のどちらか大きい方を格納できるように、データ バッファーを指定します。
Get Next Extended（36）にある Extended オペレーションの入力バッファーの情報に従って、データ バッファーを初期化します。
5. キー バッファーに、論理位置を確立した前のオペレーションで取得したキー値を設定します。キー バッファーには、前の呼び出しで MicroKernel エンジンから返されたキー値とまったく同じものを渡します。ここに格納された情報が、ファイル内の現在の位置を決定するために必要となるからです。
6. キー番号パラメーターを、論理位置を確立した前の呼び出しで使用したキー パスに設定します。Get Next Extended オペレーションを使ってキー パスを変更することはできません。
詳細
以下のトピックで、Extended オペレーションの入力バッファーの構造体とそのフィルター セグメントの使用について、さらにオペレーションの結果を返す出力バッファーの構造体について説明します。
Extended オペレーションの入力バッファー
次の表は、Get および Step の Extended オペレーションの入力バッファーの構造体を示しています。このバッファーはすべての Extended オペレーションに適用されますが、既に述べたように使用方法に違いがあります。
LIKE 結果の照合順序
比較演算子コードを Extended オペレーション コード 7（バイアス +8）として指定するオペレーションでは、次の表に示すように、照合順序フィールドは既存の ACS、ISR テーブル、ICU 照合順序、またはコード ページを参照することができます。形式は、識別バイトの後に名前が続く形です。
JSON クエリ演算子の使用
JSON クエリ演算子を使用すると、JSON 文字列として格納されたデータを含んでいるレコードをフィルターすることができます。レコード内で、文字列データは ZSTRING または CLOB データ型として格納されている可能性があります。フィルター要素には比較定数を含める必要があります。比較定数は、レコード内の JSON データが満たしている必要のあるフィルター条件を指定する文字列とします。この文字列は JSON クエリとも呼ばれ、文字列自体は、ここに記載されている例に示すように、JSON を使用して指定されます。
JSON クエリ演算子は現在、コード ページ、ACS、および照合順序をサポートしていません。ZSTRING または CLOB データ フィールドのエンコードは、シングル バイトの Windows ANSI コード ページまたは UTF-8 にすることができます。
JSON クエリ演算子を使用する場合、フィルター条件に指定する比較定数は、次の例に示すような JSON 構文を使用する有効な JSON クエリでなければなりません。これはヌルで終了している必要があります。フィルター文字列が適切な JSON 形式でない場合、Extended オペレーションは、ディスクリプターが無効であることを示すステータス コード 62 で失敗します。
JSON クエリ演算子を使用するとき、比較する対象のレコードのフィールドが JSON 仕様に従っていない場合は、レコードは条件を満たさないものとして扱われます。
JSON クエリの例
次の例は、JSON のフィルタリングに必要な構文を示しています。
クエリ ::= { <式> }
<式> ::= <json 式> | <json 式> , <式>
<json 式> ::=
"$and" : [ <中かっこで囲まれた json 式> , <中かっこで囲まれた json 式> ] |
"$not" : <中かっこで囲まれた json 式> |
"$or" : [ <中かっこで囲まれた json 式> , <中かっこで囲まれた json 式> ] |
<フィールド式>
<中かっこで囲まれた json 式> ::=
<中かっこで囲まれた json 式> |
<中かっこで囲まれた json 式> , <中かっこで囲まれた json 式>
<中かっこで囲まれた json 式> ::= { <json 式> }
<フィールド式> ::=
<フィールド> : <値> |
<フィールド> : { "$exists" : false | true } |
<フィールド> : { "$in" : [ <値> , <複数値> ] } |
<フィールド> : { "$nin" : [ <値> , <複数値> ] } |
<フィールド> : { "$type" : <型> } |
<フィールド> : { <演算子> : <値> } |
<フィールド> : { <フィールド式> }
<フィールド> ::= <文字列>
<複数値> ::= <値> | <値> , <複数値>
<値> ::= false | true | NULL | <文字列> | <数値> | <配列>
<型> ::= "array" | "boolean" | "null" | "number" | "object" | "string"
<演算子> ::= "$eq" | "$gt" | "$gte" | "$lt" | "$lte" | "$ne"
JSON 式で、クエリ値が配列でなくドキュメント値が配列である場合は、配列内の各要素が評価されます。すべての評価が true を返せば、JSON 式は true を返します。
Bureau of Transportation Statistics データから派生した別の例では、JSON 形式の航空会社の飛行データのレコードには、次のようなフィールドがあるかもしれません。
{
"airport_code" : "ATL",
"carrier_code" : "AA"
...
}
ハーツフィールド ジャクソン アトランタ国際空港（Hartsfield-Jackson Atlanta International Airport（ATL））においてアメリカン航空（American Airlines（AA））に関連するレコードを検索するには、次のクエリ文字列を使用できます。
{ "$and" : [ { "airport_code" : { "$eq" : "ATL" } },
{ "carrier_code" : { "$eq" : "AA" } } ] }
クエリ文字列に JSON 形式を使用していることに注意してください。構文の確認に JSON の検証ツールが役立つかもしれません。
フィルター内の論理 AND および OR の処理
MicroKernel エンジンでは Extended オペレーションのフィルターに含まれる AND および OR 演算子は、厳密に左から右へ向かって解釈されます。次の規則に従って、フィルター内の式の評価を続けていきます。
• 現在のレコードに適用された式が真で、次の演算子が OR の場合、そのレコードはフィルター条件を満たすものと見なされます。
• 式が真で、次の演算子が AND の場合、次のいずれかの状況になるまで各式の評価が継続されます。
• 次の OR 式に達する。
• 式の 1 つが偽と評価される。
• フィルターの末尾に達する。
• 式が偽で、次の演算子が OR の場合、フィルター内の次の式が引き続き評価されます。
• 式が偽で、次の演算子が AND の場合、そのレコードは拒否されます。
次のいずれかの条件を満たすと、レコードの検索は中止されます。
• フィルター条件を満たす、指定した数のレコードが検出される。
• フィルター条件を満たすレコードを検索している間に、検索したレコード数が指定したリジェクト カウントの最大数を超える。
• 現在のキー パスがフィルター条件のフィールドとして使用されており、それ以降ファイルの残り部分にフィルター条件を満たすレコードはないとする、拒否レコードに達する。
• ファイルの末尾に達する。
レコードのフィルタリングの例
フィルター条件を満たす次のレコード全体を取得するには、フィルター部分を設定し、次のようにディスクリプター フィールドを設定します。
1. レコード数を 1 に設定します。
2. フィールド数を 1 に設定します。
3. フィールド長を取得するレコード全体の長さに設定します。
4. フィールドのオフセットを 0 に設定します。
フィルター条件を使わずに次の 12 件のレコードを取得し、各レコードから 4 つのフィールドを抽出するには、論理式の項の数を 0 に設定し、次のようにディスクリプター フィールドを設定します。
1. レコード数を 12 に設定します。
2. フィールド数を 4 に設定します。
3. 抽出する 4 つのフィールドごとにフィールド長およびフィールドのオフセット パラメーターを設定します。
Extended オペレーションの出力バッファー
Extended Get または Step オペレーションを使ってレコードの 1 つ以上のフィールドまたは部分を取得するときは、データ バッファーがオペレーションから返される情報を十分に格納できることを確認しておく必要があります。次の表は、戻り出力バッファーの構造体を示しています。
返されたすべてのレコードまたはレコードのフィールドが固定長である場合、戻りデータ バッファー内のデータの位置は簡単に計算できます。しかし、Extended オペレーションから返されたデータ バッファーからレコードの可変長部分を抽出するには、さらに特別な手順を踏む必要があります。
レコードの可変長部分が返されるとき、MicroKernel エンジンは戻りデータ バッファー内に余分なレコード イメージを詰め込みません。したがって、レコードの可変長部分が占有する最大のバイト数を想定して戻りデータ バッファー内の領域を確保しても、実際に返されたデータがその最大値を下回る場合、MicroKernel エンジンでは次に返されたフィールドのフィールド記述は現在のフィールドのデータの直後から始まることになります。
たとえば、エントリ ポイントが 4 バイトのレコード アドレスを使用すると仮定して、固定レコード長が 100 バイトで、可変長部分は最大 300 バイトになると推定されるときに、5 件のレコードの可変長部分だけを取得したいとします。入力バッファーのディスクリプター要素を使って、フィールド長を 300 に設定し、フィールドのオフセットを 100 に設定します。戻りバッファーについては、次の計算式で示すように、レコード数を示す 2 バイトと、レコード当たり 306 バイト（つまり、長さの 2 バイト、アドレスの 4 バイト、およびデータの 300 バイト）を加算する必要があります。
2 + ((2 バイト + 4 バイト + 300 バイト) * 5) = 1532 バイト
しかし、返された先頭レコードの可変長部分には 50 バイトのデータしかなかったとします。その結果、2 バイトから成る 2 番目に返されるレコードの長さは、データ バッファーのオフセット 58、つまり先頭レコードのフィールド イメージの直後に格納されることになります。こうした状況でもアプリケーションでは、MicroKernel エンジンからデータ バッファーに返された長さ、位置、およびデータを正確に解析する必要があります。
結果
Get Next Extended オペレーションが正常に終了した場合は、MicroKernel エンジンから次の情報が返されます。
• 出力バッファー長には、受け取った総バイト数が格納されます。
• キー バッファーには、受け取った最後のデータ レコードのキー値が格納されます。
Get Next Extended オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
MicroKernel エンジンは 0 以外のステータス コードに加え、有効なデータも返すことがありますが、返された最後のレコードは不完全です。返されたバッファー長が 0 より大きい場合は、抽出されたデータのバッファーを確認してください。
レコードが短すぎるためにフィールドを部分的にしか格納できない場合は、MicroKernel エンジンではその部分フィールドも含め、格納できるだけのレコード部分が返されます。部分フィールドが抽出される最後のフィールドである場合、エンジンではオペレーションが続行されます。そうでない場合、オペレーションは中止され、ステータス コード 22 が返されます。
たとえば、Get Next Extended オペレーションで、2 件の可変長レコードから 3 つのフィールドを取得するとします。最初のレコードは 55 バイトで、2 番目のレコードは 50 バイトの長さだとします。出力バッファーには 50 バイトのデータを返すことができます。取得する 3 つのフィールドは次のように定義されています。
• フィールド 1 はオフセット 2 から始まり、2 バイト長です。
• フィールド 2 はオフセット 45 から始まり、10 バイト長です。
• フィールド 3 はオフセット 6 から始まり、2 バイト長です。
MicroKernel エンジンで Get Next Extended オペレーションが実行されるとき、最初のレコードは問題なく返されます。しかし、次にフィールド 2 の 10 バイトを抽出しようとすると、オフセット 45 とレコードの末尾のオフセット 49 の間では 5 バイトしか取得できないことが MicroKernel エンジンによって検出されます。この時点で、MicroKernel エンジンはフィールド 2 の不足している 5 バイト分を詰め込まないため、フィールド 3 は抽出できなくなります。その代わりに、ステータス コード 22 が返され、フィールド 1 全体とフィールド 2 の先頭 5 バイトが戻りデータ バッファーに格納されます。
MicroKernel エンジンではフィルター条件で使用するフィールドと演算子によって、要求を最適化できる場合があります。拒否レコードに達すると、ステータス コード 64 が返され、ファイルの未検索の部分にはフィルター条件を満たすレコードがそれ以上ないことが示されます。
ポジショニング
Get Next Extended オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立されます。検索された最後のレコードが現在のレコードになります。このレコードは、フィルター条件を満たして取得されたレコードか、またはフィルター条件を満たさないために拒否されたが、まだ最適化の範囲を超えていないレコードのいずれかです。たとえば、Extended オペレーションがステータス 9（ファイルの終わり）を返した場合は、ファイルの末尾のレコードが現在のレコードになります。ステータス 60（リジェクト カウントに達しました）が返された場合は、拒否された最後のレコードが現在のレコードです。ステータス 64（フィルター制限に達しました）が返された場合には、最適化条件を満たす最後のレコードが現在のレコードになります。これ以降のレコードは最適化の範囲を超えていることを確認するために、MicroKernel エンジンが次のレコードを検索する必要があったとしても、現在のレコードの設定は条件を満たしていた以前のレコードに戻されます。
Get Position（22）
Get Position オペレーション（B_GET_POSITION）では、現在のレコードの物理位置を返します。Get Position オペレーションを発行するときに物理カレンシーが確立されていないと、オペレーションは正常に実行されません。レコードの位置（アドレス）を決定できれば、Get Direct/Record（23）を使って、ファイル内の物理位置を基にそのレコードを直接取得できるようになります。MicroKernel エンジンでは、Get Position 要求を処理するためにディスク I/O は行われません。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• アプリケーションでは、物理カレンシーを確立しておくことが必要です。
手順
1. オペレーション コードを 22 に設定します。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を少なくとも 4 バイトに設定します。BTRVEX エントリ ポイントを使用している場合は、少なくとも 8 バイトが必要です。
4. キー番号を 0 に設定します。
結果
Get Position オペレーションが正常に終了した場合は、MicroKernel エンジンからレコードの位置がデータ バッファーに返されます。位置はバイナリ値で、ファイル内におけるレコードのオフセットを示します。また、MicroKernel エンジンはデータ バッファー長を、BTRV タイプのエントリ ポイントの場合は 4 バイト、BTRVEX タイプのエントリ ポイントの場合は 8 バイトに設定します。
Get Position オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Get Position オペレーションは、ポジショニングにまったく影響しません。
Get Previous（7）
Get Previous オペレーション（B_GET_PREVIOUS）では、指定されたキーに基づいて、論理位置で前にあるレコードを取得します。Get Previous オペレーションを使うと、重複するキー値を持つレコードのグループの中でレコードを検索できます。
Get Key（+50）バイアスを使うと、ファイル内に値が存在するかどうかを検出することもできます。一般に、Get Key オペレーションの方が高速に処理されます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
• アプリケーションでは、指定したキーに基づく前の論理位置を確立しておくことが必要です。
手順
1. オペレーション コードを 7 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
4. キー バッファーに、論理位置を確立した前のオペレーションで取得したキー値を指定します。
キー バッファーには、前の呼び出しで MicroKernel エンジンから返されたキー値とまったく同じものを渡します。ここに格納された情報が、ファイル内の現在の位置を決定するために必要となるからです。
5. キー番号パラメーターを、論理位置を確立した前の呼び出しで使用したキー パスに設定します。Get Previous オペレーションを使ってキー パスを変更することはできません。
結果
Get Previous オペレーションが正常に終了した場合、MicroKernel エンジンではキー バッファーが新しいレコードのキー値を使って更新され、データ バッファーに前のレコードが返され、データ バッファー長にそのレコードの長さが返されます。
Get Previous オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
このオペレーションの実行により、論理位置の直前がファイルの先頭よりも前を指す場合は、ステータス コード 9 が返されます。
ポジショニング
Get Previous オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、取得したレコードが現在のレコードになります。
Get Previous Delete Extended（86）
Get Previous Delete Extended オペレーション（B_GET_PREV_EXT_DELETE）では、指定されたキーに基づき、論理位置の直前からファイルの先頭へ向かって 1 つまたは複数のレコードを検索します。検索したレコードをフィルター条件と比較し、条件に一致するレコードを取得します。フィルター条件は論理式の形を取り、キー フィールドに限定されません。
このトピックで述べるように、このオペレーションが使用する入力および出力バッファー構造体、および返す結果は、
Get Next Extended（36）に記載されているものと同じです。詳細については、当該オペレーションを参照してください。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
• 指定したキーに基づく前の論理位置を確立しておくことが必要です。
手順
1. オペレーション コードを 86 に設定します。
デフォルトでは、ロック バイアスはノーウェイトで、どのロック バイアス設定も無視されます。動作は +500 と同じです。エンジンは、ロックされたレコードを削除できない場合には、オペレーションを再試行しないで直ちに戻ります。
2. ファイルのポジション ブロックを渡します。
3. 入力構造体と戻り出力のどちらか大きい方を格納できるように、データ バッファーを指定します。
Get Next Extended（36）にある Extended オペレーションの入力バッファーの情報に従って、データ バッファーを初期化します。
5. キー バッファーに、論理位置を確立した前のオペレーションで取得したキー値を指定します。
キー バッファーには、前の呼び出しで MicroKernel エンジンから返されたキー値とまったく同じものを渡します。ここに格納された情報が、ファイル内の現在の位置を決定するために必要となるからです。
6. キー番号パラメーターを、論理位置を確立した前の呼び出しで使用したキー パスに設定します。Get Previous Delete Extended オペレーションを使ってキー パスを変更することはできません。
詳細
Get Next Extended（36）の以下のトピックで、Extended オペレーションの入力バッファーの構造体とそのフィルター セグメントの使用について、さらに結果を返す出力バッファーの構造体について説明されています。
結果
このオペレーションでは、
Get Next Delete Extended（85）と同様の結果が返されます。詳細については、当該オペレーションを参照してください。
ポジショニング
Get Previous Delete Extended オペレーションでは、カレンシーは確立しません。ただし、Get Next オペレーションまたは Get Previous オペレーションを実行することができ、次または前の論理位置は有効です。また、Get Position（22）および Get Direct/Record（23）を使用することにより、有効な現在の位置も使用可能になります。
次のリストは、選定されたステータス コードとフィルター条件の関係を示しています。
• ステータス 60（リジェクト カウントに達しました）：現在の位置は、フィルター条件に一致しないレコードです。
• ステータス 64（フィルター制限に達しました）：現在の位置は、フィルター条件に一致しない可能性のあるレコードです。次または前のレコードに進もうとしても、フィルター条件に一致しません。
• ステータス 84（レコードまたはページはロックされています）：現在の位置は、フィルター条件に一致しない可能性のあるレコードです。また、次のレコードはフィルター条件に一致するが、ロックされているために削除できないという可能性もあります。
• ステータス 22（データ バッファーがいっぱいです）：現在の位置は、フィルター条件に一致するレコードです。ただし、データ バッファーにはレコード アドレスを書き込むためのスペースがないため、MicroKernel エンジンはそのレコードを削除しませんでした。
• ステータス 9（ファイルの終わり）：現在の位置は、論理的にも物理的にも無効です。
Get Previous Extended（37）
Get Previous Extended オペレーション（B_GET_PREV_EXTENDED）では、指定されたキーに基づき、論理位置の直前からファイルの先頭へ向かって 1 つまたは複数のレコードを検索します。検索したレコードをフィルター条件と比較し、条件に一致するレコードを取得します。フィルター条件は論理式の形を取り、キー フィールドに限定されません。
Get Previous Extended オペレーションでは、レコードから指定した部分だけを抽出し、その部分だけをアプリケーションに返すこともできます。
このトピックで述べるように、このオペレーションが使用する入力および出力バッファー構造体、および返す結果は、
Get Next Extended（36）に記載されているものと同じです。詳細については、当該オペレーションを参照してください。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルがデータオンリー ファイルであってはいけません。
• 指定したキーに基づく前の論理位置を確立しておくことが必要です。
手順
1. オペレーション コードを 37 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. 入力構造体と戻り出力のどちらか大きい方を格納できるように、データ バッファーを指定します。
Get Next Extended（36）にある Extended オペレーションの入力バッファーの情報に従って、データ バッファーを初期化します。
5. キー バッファーに、論理位置を確立した前のオペレーションで取得したキー値を指定します。
キー バッファーには、前の呼び出しで MicroKernel エンジンから返されたキー値とまったく同じものを渡します。ここに格納された情報が、ファイル内の現在の位置を決定するために必要となるからです。
6. キー番号パラメーターを、論理位置を確立した前の呼び出しで使用したキー パスに設定します。Get Previous Extended オペレーションを使ってキー パスを変更することはできません。
詳細
このオペレーションでは、
Get Next Extended（36）の場合と同じ入力バッファーおよび出力バッファーを使用します。詳細については、当該オペレーションを参照してください。
結果
このオペレーションでは、
Get Next Extended（36）と同様の結果が返されます。詳細については、当該オペレーションを参照してください。
ポジショニング
Get Previous Extended オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立されます。検索された最後のレコードが現在のレコードになります。このレコードは、フィルター条件を満たして取得されたレコードか、またはフィルター条件を満たさないために拒否されたレコードのいずれかです。
Insert（2）
Insert オペレーション（B_INSERT）では、ファイルにレコードを挿入します。MicroKernel エンジンでは新しいレコードのキー値を反映して、キーの B ツリーが調整されます。
パラメーター
メモ： NCC（No-currency-change：カレンシー変更なし）オプションを使用すると、Insert オペレーションはキー バッファー パラメーターの値を更新しません。つまり、このパラメーターには何の情報も返されません。
前提条件
• 対象となるファイルが開いていることが必要です。
• 挿入するレコードは適切なレコード長を持つ必要があります。また、キー値は対象となるファイルで定義されているキーと一致していなければなりません。
手順
1. オペレーション コードを 2 に設定します。
2. ファイルのポジション ブロックを渡します。
3. データ バッファーに、挿入するレコードを格納します。
4. データ バッファー長を指定します。この値は、少なくともレコードの固定長部分と同じ長さでなければなりません。
5. MicroKernel エンジンがポジショニング情報（カレンシー）の確立に使用するキー番号を指定します。NCC オプションを使用するには、キー番号に -1 を指定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
結果
Insert オペレーションが正常に終了した場合、MicroKernel エンジンではファイルに新しいレコードが挿入され、新しいレコードを反映してキーの B ツリーが更新されます。また、指定したキーの値がキー バッファーに返されます。MicroKernel エンジンでは、autoincrement キーの値がバイナリ 0 に初期化されているレコードを挿入すると、挿入したレコードもデータ バッファーに返され、レコードには MicroKernel エンジンによって割り当てられた autoincrement 値が入っています。NCC Insert オペレーションでは、キー バッファー パラメーターの値は変更されません。
Insert オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
NCC オプションを指定しない Insert オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、挿入したレコードが現在のレコードになります。論理カレンシーは指定したキーに基づきます。
NCC Insert オペレーションを実行すると、論理カレンシーは影響を受けずに、物理カレンシーが確立されます。つまり、NCC Insert オペレーションを実行したアプリケーションでは、ファイル内の論理位置は Insert オペレーションを実行する前と変わらないということです。このような状況で、NCC Insert オペレーションに続けて、Get Next（6）、Get Next Extended（36）、Get Previous（7）、および Get Previous Extended（37）などのオペレーションを実行すると、NCC Insert オペレーション実行以前のアプリケーションの論理カレンシーに基づく値が返されます。
メモ： MicroKernel エンジンでは、NCC Insert オペレーションを実行しても、その結果として何の情報もキー バッファーには返されません。したがって、論理カレンシーの維持が必要なアプリケーションでは、NCC Insert オペレーション後にキー バッファーの値を変更しないでください。変更すると、次の Get オペレーションの結果は予測できないものになります。
MicroKernel エンジンでは標準の Insert オペレーションと NCC Insert オペレーションのどちらを実行しても、新しく挿入されたレコードに対し物理カレンシーが確立されます。NCC Insert オペレーションに続く Step Next（24）、Step Next Extended（38）、Step Previous（35）、Step Previous Extended（39）、Update（3）、Delete（4）、および Get Position（22）などのオペレーションは、新しい物理カレンシーに基づいて機能します。
Insert Extended（40）
Insert Extended オペレーション（B_EXT_INSERT）では、ファイルに 1 つまたは複数のレコードを挿入します。MicroKernel エンジンでは、新しいレコードのキー値を反映して、キーの B ツリーが調整されます。
パラメーター
メモ： NCC（No-currency-change：カレンシー変更なし）オプションを使用すると、Insert Extended オペレーションはキー バッファー パラメーターの値を更新しません。つまり、このパラメーターには何の情報も返されません。
前提条件
• 対象となるファイルが開いていることが必要です。
• 挿入するレコードは適切なレコード長を持つ必要があります。また、キー値は対象となるファイルで定義されているキーと一致していなければなりません。
手順
1. オペレーション コードを 40 に設定します。
2. ファイルのポジション ブロックを渡します。
3. 詳細 に示す構造体に従って、データ バッファーを指定します。
4. データ バッファー長を指定します。この値は、データ バッファー構造体のサイズと一致している必要があります。
5. MicroKernel エンジンがカレンシーの確立に使用するキー番号を指定します。NCC オプションを使用するには、キー番号に -1 を指定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
詳細
次の表は、Insert Extended オペレーションの入力データ バッファーの構造体を示しています。
結果
Insert Extended オペレーションが正常に終了した場合、MicroKernel エンジンではファイルに新しいレコードが挿入され、オペレーションが NCC Insert Extended でない場合は、挿入された新しいレコードを反映してすべての B ツリーが更新されます。さらに、最後に挿入したレコードから、指定したキーの値がキー バッファーに返されます。また、戻りデータ バッファーの先頭 2 バイトまたは 4 バイトの符号なし整数には、ファイルに正常に挿入されたレコードの数が MicroKernel エンジンによって格納されます。レコード数の後には、挿入されたレコードのアドレスが MicroKernel エンジンによって格納されます。次の表は、出力データ バッファーの構造体を示しています。
オペレーションの一部しか正常に実行されず、MicroKernel エンジンから 0 以外のステータス コードが返された場合、データ バッファーの先頭 2 バイトまたは 4 バイトの符号なし整数の値は、正常に挿入されたレコードの数と等しくなります。エラーの原因となったレコードは、正常に挿入されたレコード数 + 1 番目のレコードです。
Insert Extended オペレーションが正常に実行されなかった場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
NCC オプションを指定しない Insert Extended オペレーションを実行すると、完全な論理カレンシーおよび物理カレンシーが確立し、挿入されたレコードのキー値がヌルでなければ、最後に挿入されたレコードが現在のレコードになります。論理カレンシーは指定したキーに基づきます。
NCC Insert Extended オペレーションを実行すると、論理カレンシーは影響を受けずに、物理カレンシーが確立されます。つまり、NCC Insert Extended オペレーションを実行したアプリケーションでは、ファイル内の論理位置はオペレーションを実行する前と変わらないということです。このような状況で、NCC Insert Extended オペレーションに続けて、Get Next（6）、Get Next Extended（36）、Get Previous（7）、および Get Previous Extended（37）などのオペレーションを実行すると、NCC Insert Extended オペレーション実行以前のアプリケーションの論理カレンシーに基づく値が返されます。
メモ： MicroKernel エンジンでは、NCC Insert Extended オペレーションを実行しても、その結果として何の情報もキー バッファーには返されません。したがって、論理カレンシーの維持が必要なアプリケーションでは、NCC Insert Extended オペレーション後にキー バッファーの値を変更しないでください。変更すると、次の Get オペレーションの結果は予測できないものになります。
MicroKernel エンジンでは標準の Insert Extended オペレーションと NCC Insert Extended オペレーションのどちらを実行しても、新しく挿入されたレコードに対し物理カレンシーが確立されます。したがって、NCC Insert Extended オペレーションに続く Step Next（24）、Step Next Extended（38）、Step Previous（35）、Step Previous Extended（39）、Update（3）、Delete（4）、および Get Position（22）などのオペレーションは、新しい物理カレンシーに基づいて機能します。
Get Next（6）オペレーションのような、元の論理カレンシーに基づくオペレーションを実行するために、アプリケーションで Insert Extended オペレーション実行前のファイルの論理位置を保存しておく必要がある場合に、NCC Insert Extended オペレーションが役立ちます。
NCC Insert Extended オペレーションを実行しないで同様の結果を得るには、アプリケーションで以下の手順を実行する必要があります。
1. Get Position（22） - 現在の論理レコードの物理アドレスを取得します。アプリケーションでこの値を保存し、手順 3 でこれを渡して元に戻します。
2. Insert Extended（40） - 新しいレコードを挿入します。このオペレーションにより、新しい論理カレンシーおよび物理カレンシーが確立されます。
3. Get Direct/Record（23） - 論理カレンシーと物理カレンシーを手順 1 での状態に戻します。
NCC Insert Extended オペレーションは、論理カレンシーについてはこの手順と同様の結果を得られますが、物理カレンシーについては異なります。たとえば、これら 2 つの手順のいずれかに続けて Get Next（6）を実行した場合は、どちらの手順でも結果は変わりませんが、Step Next（24）を実行した場合は、異なるレコードが返される可能性があります。
Login/Logout（78）
Login/Logout オペレーション（B_LOGIN/B_LOGOUT）では、ユーザーは資格情報を指定して、データベース エンジンから認証トークンおよび許可トークンを取得することができます。また、データベースへのアクセスを取得するために資格情報の再入力が必要となるよう、ユーザーは資格情報をリセットすることもできます。
パラメーター
前提条件
• データベース名およびユーザー ID はあらかじめ定義されている必要があります。
ログイン手順
1. オペレーション コードを 78 に設定します。
2. キー番号を 0 に設定します。
3. データベース URI の形式を用いて、キー バッファーにサーバー名、データベース名、ユーザー ID、およびパスワードを設定しますURI 接続文字列の詳細については、『
Zen Programmer's Guide』の
データベース URI を参照してください。
ログアウト手順
1. オペレーション コードを 78 に設定します。
2. キー番号を 1 に設定します。
3. データベース URI の形式を用いて、キー バッファーにサーバー名、データベース名、ユーザー ID、およびパスワードを設定します『
Zen Programmer's Guide』の
データベース URI を参照してください。
結果
Login または Logout オペレーションが正常に終了した場合は、ステータス 0 が返されます。正常に実行されなかった場合は、次のステータス コードのいずれかが返されます。
注記
データベース URI を結合した長さは 255 バイト未満でなければなりません。これがキー バッファーの最大サイズだからです。
Login オペレーションではパフォーマンスに負荷がかかります。アプリケーション、ファイルごとにログインおよびログアウトするようなコーディングをしないでください。代わりに、セッションの始めに一度データベースにログインし、データベース作業が完了したらログアウトするようにしてください。
ポジショニング
Login/Logout オペレーションは、ファイルのカレンシー情報にはまったく影響しません。
Open（0）
Open オペレーション（B_OPEN）は、ファイルへのアクセスを可能にします。アプリケーションでファイルにアクセスするには、まず Open オペレーションを実行する必要があります。絶対パス名または相対パス名を指定する限り、対象となるファイルが現在のディレクトリに保存されている必要はありません。
パラメーター
前提条件
• 開くファイルは、アクセス可能な論理ディスク ドライブ上にあることが必要です。
• そのファイルで使用可能なファイル ハンドルが存在することが必要です。
手順
1. オペレーション コードを 0 に設定します。
2. ファイルにオーナーが設定されている場合は、データ バッファー パラメーターにオーナー ネームを指定し、末尾にバイナリ 0 を付けます。
3. データ バッファー長パラメーターに、バイナリ 0 を含めたオーナー ネームの長さを指定します。
キー バッファー パラメーターに、開くファイルのパス名を入れます。埋め込みスペースの設定に応じて、パス名の終端はヌル（バイナリ ゼロ）にします。パス名は半角 255 文字までの範囲で指定できます。ヌル終端文字を含む完全修飾 UNC（Unified Naming Convention）パス名は、半角 255 文字までの範囲で指定できます。
MicroKernel エンジンは通常、ファイル名を完全修飾 UNC ファイル名に拡張します。たとえば、Z:
\Data
\File.dat は
\\サーバー名
\共有名
\Data
\File.dat に変換されます。この拡張された名前が、ヌル終端文字を含めて半角 255 文字までにならなければなりません。『
Zen Programmer's Guide』の
データベース URI も参照してください。
ただし、Btrieve の Open 要求がローカル エンジンに送られる場合は、MIF はローカルのドライブ文字をコンピューター名および共有名に置き換えません。もっと長いパス名のファイルをローカルで正常に開くことができたとしても、リモート クライアントではそのファイルを開けないことがあります。
クライアント構成の［スペースを含むファイル/ディレクトリ名］設定によって、埋め込みスペースを含むファイル名がサポートされます。デフォルトでは、この設定はオンになっています。つまり、スペースはパスの一部と見なされます。この設定がオンの場合、ファイル名はヌル バイトで区切る必要があります。この設定がオフの場合、埋め込みスペースを含むファイル名（C:
\My Folder
\my file.mkd など）を使用することはできません。『
Advanced Operations Guide』の
長いファイル名と埋め込みスペースのサポートを参照してください。
4. キー番号パラメーターに、このトピックの「詳細」で示す表に記載されているモード値のいずれかを指定します。
詳細
ここでは、サポートされているオープン モードについて説明します。
注意！ データベース エンジンは、クライアントがアクセラレイティド モードを使用している間は、クライアントのトランザクション アトミシティ、トランザクション一貫性保持、およびアーカイブ ログの安全性を保証できません。この制約があるのは、ログからの復元が必要な場合に、完全な復元を行うために十分な情報がログに含まれていない可能性があるからです。なぜなら、ログは、1 つのデータ ファイル上で行った操作の部分的な記録でしかないからです。
たとえば、アクセラレイティド モードを使用して挿入を実行するクライアントと、ノーマル モードを使用して更新を実行するクライアントが同じファイルにアクセスしているときにシステム障害が発生した場合、トランザクション ログには、データ ファイルにまだ存在しないレコードに対する更新が含まれている可能性があります。これは、メモリ内のアクセラレイティドの挿入操作は一度もディスクにフラッシュされていませんが、トランザクショナルな更新操作はトランザクション ログに書き込まれているためです。
この操作の組み合わせを含むアーカイブ ログをロール フォワードしようとすると、失敗します。
ファイルを開くときに、次の表に示すオープン モードによって、ローカル エンジンとリモート エンジンのどちらを使用するかを MicroKernel エンジンに指示できます。キー番号パラメーターにオープン モードの値を指定します。
メモ： ローカル エンジンでファイルを開くように指定する場合は、ワークグループ エンジンでもサーバー エンジンでも、Open オペレーションに何ら違いはありません。
開いているファイルの最大数について定められた制限はありません。同時に開くことができるファイルの数は、使用可能なメモリに応じて変わります。
ファイルは、MicroKernel エンジンによって 1 回だけ開かれます。エンジンは、複数のクライアントが同時に 1 つのファイルを開いている状況や、単独のクライアントがファイルのポジション ブロックを複数持っている状況を認識し、処理します。拡張ファイルを開くとき、エンジンでは 1 つのハンドルが使用され、ベース ファイルとすべてのエクステンション ファイルが開かれます。
結果
Open オペレーションが正常に終了した場合、MicroKernel エンジンでは目的のファイルにファイル ハンドルが割り当てられ、新しく開いたファイルの Open 呼び出しで渡したポジション ブロックが予約されて、そのファイルがアクセス可能な状態になります。
Open オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
次の表は、ローカル クライアントで使用できるオープン モードの組み合わせを示しています。
ポジショニング
Open オペレーションを実行しても、ポジショニングは確立しません。ただし、次の物理レコードがファイルの先頭の物理レコードになります。
Reset（28）
Reset オペレーション（B_RESET）では、クライアントが保持しているすべてのリソースを解放します。このオペレーションは、クライアントが実行中のトランザクションを中止し、すべてのロックを解除し、さらに、クライアントが開いているファイルをすべて閉じます。
パラメーター
前提条件
MicroKernel エンジンまたはリクエスターがロードされていて、Reset 呼び出しを発行するクライアントが MicroKernel エンジンとの接続を確立していれば、アプリケーションではいつでも Reset オペレーションを発行できます。接続は、たとえば、ファイルを開いたり、Zen ツールを使ってファイルのステータスを要求したりすることにより確立します。
手順
1. オペレーション コードを 28 に設定します。
2. キー番号およびキー バッファー パラメーターを 0 に設定します。
結果
Reset オペレーションが正常に終了した場合、MicroKernel エンジンでは指定したクライアント、ウィンドウ、またはセッションに対して次の動作が実行されます。
1. 実行中のトランザクションがすべて中止される。
2. 保持されているすべてのロックが解除される。
3. 開いているファイルがすべて閉じられる。
Reset オペレーションが失敗した場合は、MicroKernel エンジンから 0 以外のステータス コードが返されます。
ポジショニング
Reset オペレーションを実行すると、開いているファイルがすべて閉じられるため、すべてのカレンシーが消去されます。
Set Directory（17）
Set Directory オペレーション（B_SET_DIR）では、指定したパス名を現在のディレクトリとして設定します。
パラメーター
前提条件
対象となる論理ディスク ドライブおよびディレクトリがアクセス可能であることが必要です。
手順
1. オペレーション コードを 17 に設定します。
2. キー バッファーに、論理ディスク ドライブおよびディレクトリ パスを、最後にバイナリ 0 を付けて格納します。ドライブ名を省略した場合、MicroKernel エンジンではデフォルトのドライブが使用されます。ディレクトリの絶対パスを指定しなかった場合、MicroKernel エンジンではキー バッファーに指定したディレクトリ パスが現在のディレクトリに追加されます。
結果
Set Directory オペレーションが正常に終了した場合、MicroKernel エンジンではキー バッファーに指定したディレクトリが現在のディレクトリになります。
Set Directory オペレーションが失敗した場合、MicroKernel エンジンでは現在のディレクトリは変更されないままで、0 以外のステータス コードが返されます。
ポジショニング
Set Directory オペレーションは、ポジショニングにまったく影響しません。
Set Owner（29）
Set Owner オペレーション（B_SET_OWNER）ではファイルにオーナー ネームを割り当てます。オーナー ネームはアクセス パスワードとして機能します。ファイルにオーナー ネームが設定されている場合は、ユーザーやアプリケーションはそのファイルにアクセスするたびにオーナー ネームの文字列を提供する必要があります。すべてのアクセス権に対し、あるいは更新権限だけに対してオーナー ネームが要求されるように指定することができます。オーナー ネームは ASCII 形式です。長いオーナー ネームの場合には、16 進数にすることもできます。オーナー ネームを割り当てるときに、ディスク上のファイルのデータを暗号化するよう MicroKernel エンジンに指示することもできます。そう指示した場合、MicroKernel エンジンでは Set Owner オペレーションの実行中にすべてのデータが暗号化されます。ファイルが長いと Set Owner の実行時間が長くなるため、パフォーマンスに影響を与える可能性があります。詳細については、『
Advanced Operations Guide』の
オーナー ネームを参照してください。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• トランザクションが実行中でないことが必要です。
• ファイルに既にオーナ ネームが設定されていてはいけません。
手順
1. オペレーション コードを 29 に設定します。
任意で、+17000 のバイアスを含めると、最長 24 バイト（半角 24 文字）の長いオーナーネームを作成することができます。このバイアスは btrconst.h に B_LONG_OWNER_NAME_BIAS としても定義されています。
2. 保護するファイルを識別するポジション ブロックを渡します。
3. データ バッファーとキー バッファーの両方にオーナー ネームを格納します。MicroKernel エンジンは、誤って不適切な値を提供するのを防ぐために、オーナー ネームを両方のバッファーに格納することを要求します。
+17000 のバイアスが設定されていない場合は、短いオーナー ネームを 8 バイト（半角 8 文字）までの範囲で指定でき、末尾はバイナリ 0 になっている必要があります。+17000 のバイアスが設定されている場合は、長いオーナー ネームを使用でき、末尾はバイナリ 0 になっている必要があります。どちらの場合も、オーナー ネームをすべてスペース（0x20）で構成することはできません。長いオーナー ネームの長さは、ファイル形式によって異なります。詳細については、
オーナー ネームを参照してください。
4. データ バッファー長パラメーターに、バイナリ 0 を含めたオーナー ネームの長さを設定します。
5. キー番号を、ファイルに対するアクセス制限と暗号化のタイプを指定する整数に設定します。次の表は、4 つのキー番号とその結果の一覧を示します。
詳細
一度オーナー ネームを指定すると、
Clear Owner（30）オペレーションを発行するまでそのオーナー ネームは有効です。上の表は、キー番号に設定できるアクセス制限コードの一覧を示しています。
結果
Set Owner オペレーションが正常に終了した場合、それ以降のオペレーションでは正しいオーナー ネームが指定されない限り、MicroKernel エンジンでファイルへのアクセスやファイルの変更を行えなくなります。唯一の例外は、オーナー ネームの指定なしで読み取り専用アクセスが許可されている場合です。
さらに、Set Owner オペレーションが正常に終了すると、暗号化が指定されている場合には、MicroKernel エンジンによってファイル内のデータが暗号化されます。暗号化は直ちに行われ、ファイル全体が暗号化されるまでは MicroKernel エンジンの制御下にあります。
パフォーマンスに関して、次のことに留意してください。MicroKernel エンジンはディスクから暗号化されたページを読み込む際にそのページを解読し、ディスクに書き込む前に再度ページを暗号化します。暗号化されたファイルからのデータの読み取りは、暗号化されていないファイルからデータを読み取る場合よりも遅くなります。また、ファイルのサイズが大きくなるほど、暗号化または解読には時間がかかります。暗号化されたファイルのシナリオでは、キャッシュが小さい場合、または比較的大量の変更操作を行う場合には、MicroKernel エンジンは暗号化ルーチンをさらに頻繁に実行しなければなりません。
Set Owner オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Set Owner オペレーションは、ポジショニングにまったく影響しません。
Stat（15）
Stat オペレーション（B_STAT）では、データ バッファーを使用して、ファイル仕様に関する統計を取得します。統計情報には、ファイルに含まれるレコードの数、ファイルの各インデックスに格納されている重複しないキー値の数、空きページの数、オルタネート コレーティング シーケンス（ACS）などがあります。ファイルを作成した以降に新しいキーや ACS 値が追加されている場合があります。この新しい情報を構成する必要があるため、
Create（14）オペレーションで使用された元のデータ バッファー サイズを再利用できない可能性があります。
パラメーター
前提条件
対象となるファイルが開いていることが必要です。
手順
1. オペレーション コードを 15 に設定します。
2. ファイルのポジション ブロックを渡します。
3. ファイルに定義されている統計情報を格納するのに十分なデータ バッファーを確保します。
4. データ バッファー長を指定します。ファイルの統計情報を十分に格納できる長さが必要です。
5. 少なくとも 255 バイトのキー バッファーを指定します。
6. 次のようにキー番号を設定します。
• ファイル バージョンを除外する場合は 0
• ファイル バージョンを含める場合は -1
詳細
Create（14）と Stat（14）は同様のデータ バッファー構造体を使用するため、構造体については、それらのわずかな違いも含め、
Create（14）でまとめて説明されています。
ファイル仕様
戻りデータ バッファーのファイル仕様フィールドは、
Create（14）で説明したものと同じですが、ファイル仕様領域内に次の例外があります。
• データ バッファーにファイルのバージョン情報が含まれている場合は、インデックス数が 1 バイト長になり、その後に 1 バイトのファイルのバージョン情報が続きます。ファイルのバージョン番号の値を 10 進数に変換しないでください。0x95 という値はそのファイルが 9.5 ファイルであることを示し、0x80 という値はそのファイルが 8.x ファイルであることを示します（以下同様）。MicroKernel エンジンではファイルを作成するとき、これらの属性に従ってバージョン番号が割り当てられます。
• レコード数は、ファイル内のレコードの数を表す 4 バイトまたは ８ バイト長の値です。
• ファイル フラグ ワードで、ビット 9（0x0200）と 12（0x1000）は次のような意味を持ちます。
Stat オペレーションでは、システム データがデフォルトで組み込まれたのか、明示的に組み込まれたのかは示されません。
• 未使用の重複ポインター数は、ファイル内に残っている未使用の重複ポインターの数を示します。
• 予約領域が割り当てられますが、MicroKernel エンジンは Stat オペレーションではこの領域を無視します。
キー仕様
戻りデータ バッファーのキー仕様フィールドは、
キー仕様ブロックで説明したものと基本的には同じです。ただし、4 バイトまたは 8 バイトの重複のないキー値の数は、指定されたキーに対して一意で重複のない値を持つレコードの数が示される点が異なります。
オルタネート コレーティング シーケンス
戻りデータ バッファーの ACS（オルタネート コレーティング シーケンス）は、
Create（14）で説明したものとまったく同じです。
結果
Stat オペレーションが正常に終了した場合、MicroKernel エンジンではファイルおよびキーの特性がデータ バッファーに返され、データ バッファーの長さがデータ バッファー長に返されます。対象となるファイルが拡張ファイルである場合、MicroKernel エンジンでは先頭のエクステンション ファイルのファイル名がキー バッファーに返されます。先頭のエクステンション ファイルのファイル名が 63 バイトを超える場合、MicroKernel エンジンではファイル名が切り詰められます。ファイルが拡張ファイルでない場合は、MicroKernel エンジンではキー バッファーの先頭バイトが 0 に初期化されます。
Stat Extended（65）オペレーションを使うと、拡張ファイルに関する情報も取得できます。
Stat オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Stat オペレーションは、ポジショニングにまったく影響しません。
Stat Extended（65）
Stat Extended オペレーション（B_EXTENDED_STAT）にはいくつかのサブファンクションがあります。これを使って、アプリケーションは開いているファイルについての情報を収集することができます。
詳細については、下記のサブファンクションのトピックを参照してください。
パラメーター
前提条件
対象となるファイルが開いていることが必要です。
手順
1. オペレーション コードを 65 に設定します。
2. ファイルのポジション ブロックを渡します。
3. データ バッファーに Stat Extended 構造体を格納します。各サブファンクションで必要な Stat Extended 構造体の詳細については、以降のセクションを参照してください。
4. データ バッファー長を指定します。
5. キー番号を 0 に設定します。
サブファンクション 1：拡張ファイル情報
入力ポジション ブロックで指定されたファイルの場合、このサブファンクションは、指定データ ファイルと関連付けられたエクステンション ファイルについての情報を返します。返される情報には、存在するエクステンション ファイルの数、関数によって返された番号、および返されたファイルの名前が含まれます。
入力データ バッファ構造体
エクステンション ファイルに関する情報を取得するには、次の表に示すようにデータ バッファーに拡張ファイル ディスクリプターを作成する必要があります。
出力データ バッファー構造体
拡張ファイル サブファンクションの場合、MicroKernel エンジンではデータ バッファー長パラメーターの値が更新され、次の表で説明されているような拡張ファイル構造体がデータ バッファーに返されます。
サブファンクション 2：システム データ情報
入力ポジション ブロックで指定されたファイルの場合、このサブファンクションは、ファイルにシステム キーが定義されているかどうか、また、そのファイルはログ可能（トランザクション一貫性保持が可能）であるかどうかに関する情報を返します。
入力データ バッファ構造体
ファイルでのシステム データの使用に関する情報を取得するには、次の表に示すようにデータ バッファーにシステム データ ディスクリプターを作成する必要があります。
出力データ バッファー構造体
システム データ サブファンクションの場合、MicroKernel エンジンでは次のようなシステム データ構造体がデータ バッファーに返されます。
サブファンクション 3：重複レコードによる競合情報
入力ポジション ブロックで指定されたファイルの場合、このサブファンクションは、重複レコードによる競合についての情報を返します。返される情報には、直前の失敗した挿入または更新操作でステータス コード 5（重複キー）の発生原因となった、レコード アドレスおよびキー番号が含まれます。
入力データ バッファー構造体
重複レコードによる競合を報告するために、一番最近ステータス コード 5（重複キー）を発生させたレコード アドレスおよびキー番号に関する情報を取得するには、データ バッファーに重複レコード情報ディスクリプターを次のとおりに作成する必要があります。
出力データ バッファ構造体
重複レコードによる競合サブファンクションの場合、MicroKernel エンジンでは次のような重複レコードによる競合構造体がデータ バッファーに返されます。
サブファンクション 4：ファイル情報
入力ポジション ブロックで指定されたファイルの場合、このサブファンクションはファイル情報を返します。返される情報には次のものが含まれます。MicroKernel エンジンがファイルの識別に使用する内部ファイル ID、現在開いているファイル ハンドル数、ファイルが前回開かれたときのタイムスタンプ、およびファイル プロパティを示すさまざまなフラグがあります。
入力データ バッファー構造体
開いているファイルに関する情報を取得するには、データ バッファーにファイル情報ディスクリプターを次のとおりに作成する必要があります。
出力データ バッファ構造体
ファイル情報サブファンクションの場合、MicroKernel エンジンでは次のようなファイル情報構造体がデータ バッファーに返されます。
フラグ フィールドに使用できる値については、次の表で説明します。
サブファンクション 5：ゲートウェイ情報
入力ポジション ブロックで指定されたファイルの場合、このサブファンクションは、ファイルの制御を行うゲートウェイ エンジンについての情報を返します。
入力データ バッファー構造体
指定されたファイルの処理を行うゲートウェイ エンジンに関する情報を取得するには、データ バッファーにゲートウェイ情報ディスクリプターを次のとおりに作成する必要があります。
出力データ バッファ構造体
ゲートウェイ情報サブファンクションの場合、MicroKernel エンジンではデータ バッファー長パラメーターが更新され、次のようなゲートウェイ情報構造体がデータ バッファーに返されます。
サブファンクション 6：ロック オーナーの識別
入力ポジション ブロックで指定されたファイルの場合、このサブファンクションは、一番最近ファイルのアクセス時にステータス コード 84 または 85 を発生させた原因に関する情報を返します。
入力データ バッファー構造体
ステータス 84 または 85 の原因に関する情報を取得するには、データ バッファーにロック オーナー情報ディスクリプターを次のとおりに作成する必要があります。
出力データ バッファー構造体
ロック オーナー情報サブファンクションの場合、MicroKernel エンジンではデータ バッファー長パラメーターが更新され、次のようなロック オーナー情報構造体がデータ バッファーに返されます。
以前にブロックしていたクライアントの記録が MicroKernel エンジンにない場合、出力データ バッファー長はゼロに設定されます。
フラグ フィールドに使用できる値については、次の表で説明します。
サブファンクション 7：セキュリティ情報
このサブファンクションは、クライアントが現在のファイルにアクセスするために、どのように認証および許可されたかについての情報を返します。セキュリティに使用されている現在のデータベースに関する情報も示します。
入力データ バッファー構造体
このハンドルがどのように認証されたか、またどのアクセス権を持っているかについてセキュリティ情報を取得するには、データ バッファーにセキュリティ情報ディスクリプターを次のとおりに作成する必要があります。
出力データ バッファー構造体
セキュリティ情報サブファンクションの場合、MicroKernel ではデータ バッファー長パラメーターが更新され、次のようなセキュリティ情報構造体がデータ バッファーに返されます。
2 つのフラグ フィールドで使用できる値については、以下の表で説明します。
サブファンクション 8：ステータス コード 71 の発生原因となる、テーブル名またはファイル名の一覧表示
このサブファンクションは、ステータス コード 71（参照整合性の定義に違反があります）の発生原因となった、テーブルまたはデータ ファイルについての情報を返します。返される情報には、ファイル名、Btrieve オペレーション コード、および参照整合性エラーが発生したレコードの位置が含まれます。
入力データ バッファー構造体
開いているファイルに関する情報を取得するには、データ バッファーにファイル情報ディスクリプターを次のとおりに作成する必要があります。
出力データ バッファー構造体
ファイル情報サブファンクションの場合、MicroKernel エンジンでは次のようなファイル情報構造体がデータ バッファーに返されます。指定されたデータ バッファーは、返されるデータを保持できる十分な大きさでなければなりません。
結果
Stat Extended オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
Step First（33）
Step First オペレーション（B_STEP_FIRST）では、ファイル内の先頭の物理レコードを取得します。MicroKernel エンジンではこのレコードを取得するためにキー パスは使用されません。
パラメーター
前提条件
対象となるファイルが開いていることが必要です。
手順
1. オペレーション コードを 33 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
結果
Step First オペレーションが正常に終了した場合、MicroKernel エンジンではファイル内の先頭の物理レコードがデータ バッファーに返され、返されたバイト数がデータ バッファー長パラメーターに設定されます。
Step First オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Step First オペレーションを実行すると、論理カレンシーが消去されます。取得したレコードを現在の物理レコードとして使用し、物理カレンシーが設定されます。物理位置の直前は、ファイルの先頭よりも前を指すことになります。
Step Last（34）
Step Last オペレーション（B_STEP_LAST）では、ファイル内の末尾の物理レコードを取得します。MicroKernel エンジンではこのレコードを取得するためにキー パスは使用されません。
パラメーター
前提条件
対象となるファイルが開いていることが必要です。
手順
1. オペレーション コードを 34 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
結果
Step Last オペレーションが正常に終了した場合、MicroKernel エンジンではファイル内の末尾の物理レコードがデータ バッファーに返され、返されたバイト数がデータ バッファー長パラメーターに設定されます。
Step Last オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Step Last オペレーションを実行すると、論理カレンシーが消去されます。取得したレコードを現在の物理レコードとして使用し、物理カレンシーが設定されます。物理位置の直後は、ファイルの末尾よりも後を指すことになります。
Step Next（24）
Step Next オペレーション（B_STEP_NEXT）では、次の物理位置として示されるレコードを取得します。MicroKernel エンジンではこのレコードを取得するためにキー パスは使用されません。
Step Next オペレーションを任意の Get または Step オペレーションの直後に実行すると、前のオペレーションで取得されたレコードの物理的に次にあるレコードが返されます。
パラメーター
前提条件
対象となるファイルが開いていることが必要です。
手順
1. オペレーション コードを 24 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
結果
Step Next オペレーションが正常に終了した場合、MicroKernel エンジンではファイル内の次の物理レコードがデータ バッファーに返され、返されたバイト数がデータ バッファー長パラメーターに設定されます。
Step Next オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Step Next オペレーションを実行しても、論理カレンシーは確立しません。取得したレコードを現在の物理レコードとして使用し、物理カレンシーが設定されます。
Delete（4）の直後に Step Next オペレーションを発行すると、Delete の前のオペレーションで次の物理レコードとして確立されたレコードが返されます。
Open（0）の直後に Step Next オペレーションを発行すると、ファイル内の先頭レコードが返されます。
Step Next Extended（38）
Step Next Extended オペレーション（B_STEP_NEXT_EXT）では、物理位置の直後からファイルの末尾へ向かって 1 つまたは複数のレコードを検索します。検索したレコードをフィルター条件と比較し、条件に一致するレコードを取得します。フィルター条件は論理式の形を取り、キー フィールドに限定されません。
Step Next Extended オペレーションでは、既存のレコードの中から指定したフィールドを抽出し、抽出したフィールドだけを含む新しいレコードのセットを返すこともできます。
このトピックで述べるように、このオペレーションが使用する入力および出力バッファー構造体、および返す結果は、
Get Next Extended（36）に記載されているものと同じです。詳細については、当該オペレーションを参照してください。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• 次の物理位置を確立しておくことが必要です。たとえば、Delete オペレーションの次に Step Next Extended オペレーションを実行することはできません。
手順
1. オペレーション コードを 38 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. 入力構造体と戻り出力のどちらか大きい方を格納できるように、データ バッファーを指定します。
Get Next Extended（36）にある Extended オペレーションの入力バッファーの情報に従って、データ バッファーを初期化します。
5. 上記の手順に従って、データ バッファー長に適切な値を指定します。
詳細
Step Next Extended オペレーションの「詳細」の内容は、Get Next Extended オペレーションと同じです。詳しくは、当該オペレーションの
詳細を参照してください。
結果
Step Next Extended オペレーションが正常に終了した場合、MicroKernel エンジンでは、取得された 1 つまたは複数のレコードに含まれる 1 つまたは複数のフィールドがデータ バッファーに返されます（
Extended オペレーションの出力バッファーを参照してください）。さらに MicroKernel エンジンから、データ バッファー長パラメーターには、データ バッファーに返されたバイト数が設定されます。
Step Next Extended オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
MicroKernel エンジンは 0 以外のステータス コードに加え、有効なデータも返すことがありますが、返された最後のレコードは不完全です。返されたバッファー長が 0 より大きい場合は、抽出されたデータの出力バッファーを確認してください。
レコードが短すぎるためにフィールドを部分的にしか格納できない場合は、MicroKernel エンジンではその部分フィールドも含め、格納できるだけのレコード部分が返されます。部分フィールドが抽出される最後のフィールドである場合、エンジンではオペレーションが続行されます。そうでない場合、オペレーションは中止され、ステータス コード 22 が返されます。
たとえば、Step Next Extended オペレーションで、2 件の可変長レコードから 3 つのフィールドを取得するとします。最初のレコードは 55 バイトで、2 番目のレコードは 50 バイトの長さだとします。出力バッファーには 50 バイトのデータを返すことができます。取得する 3 つのフィールドは次のように定義されています。
• フィールド 1 はオフセット 2 から始まり、2 バイト長です。
• フィールド 2 はオフセット 45 から始まり、10 バイト長です。
• フィールド 3 はオフセット 6 から始まり、2 バイト長です。
MicroKernel エンジンで Step Next Extended オペレーションが実行されるとき、最初のレコードは問題なく返されます。しかし、2 番目のレコードのフィールド 2 から 10 バイトを抽出しようとすると、MicroKernel エンジンではオフセット 45 とレコードの末尾のオフセット 49 の間では 5 バイトしか取得できないことが検出されます。この時点で、MicroKernel エンジンはフィールド 2 の不足している 5 バイト分を詰め込まないため、フィールド 3 は抽出できなくなります。その代わりに、MicroKernel エンジンからステータス コード 22 が返され、フィールド 1 全体とフィールド 2 の先頭 5 バイトが戻りデータ バッファーに格納されます。
MicroKernel エンジンではフィルター条件で使用するフィールドと演算子によって、要求を最適化できる場合があります。拒否レコードに達すると、ステータス コード 64 が返され、ファイルの未検索の部分にはフィルター条件を満たすレコードがそれ以上ないことが示されます。
ポジショニング
Step Next Extended オペレーションを実行しても、論理カレンシーは確立しませんが、検索された最後のレコードが現在の物理レコードになります。このレコードは、フィルター条件を満たして取得されたレコードか、またはフィルター条件を満たさないために拒否されたレコードのいずれかです。
Step Next Delete Extended（87）
Step Next Delete Extended オペレーション（B_STEP_NEXT_EXT_DELETE）では、物理位置の直後からファイルの末尾へ向かって 1 つまたは複数のレコードを検索します。検索したレコードをフィルター条件と比較し、条件に一致するレコードを削除します。フィルター条件は論理式の形を取り、キー フィールドに限定されません。
このトピックで述べるように、このオペレーションが使用する入力および出力バッファー構造体、および返す結果は、
Get Next Extended（36）に記載されているものと同じです。詳細については、当該オペレーションを参照してください。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• 次の物理位置を確立しておくことが必要です。たとえば、Delete オペレーションの次に Step Next Extended オペレーションを実行することはできません。
手順
1. オペレーション コードを 87 に設定します。
デフォルトでは、ロック バイアスはノーウェイトで、どのロック バイアス設定も無視されます。動作は +500 と同じです。エンジンは、ロックされたレコードを削除できない場合には、オペレーションを再試行しないで直ちに戻ります。
2. ファイルのポジション ブロックを渡します。
3. 入力構造体と戻り出力のどちらか大きい方を格納できるように、データ バッファーを指定します。
Get Next Extended（36）にある Extended オペレーションの入力バッファーの情報に従って、データ バッファーを初期化します。
詳細
Get Next Extended（36）の以下のトピックで、Extended オペレーションの入力バッファーの構造体とそのフィルター セグメントの使用について、さらに結果を返す出力バッファーの構造体について説明されています。
結果
Step Next Delete Extended オペレーションが正常に終了した場合は、MicroKernel エンジンにより 1 つまたは複数のレコードが削除されます。さらに MicroKernel エンジンから、データ バッファー長パラメーターには、データ バッファーに返されたバイト数が設定されます。
Step Next Delete Extended オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
出力バッファーの長さがゼロの場合、レコードは削除されていません。ただし、オペレーションが失敗する前に一部のレコードを正常に削除している可能性があります。以下に、このような一部成功のいくつかの例を示します。
• フィルター条件に一致する現在のレコードのレコード アドレスを書き出すためのスペースが出力バッファーにありません。そのレコードは削除されず、オペレーションはステータス コード 22 で失敗します。
• 別のクライアントが現在のレコードをロックしている場合、オペレーションはステータス コード 84 で失敗します。
このような場合、出力バッファー長はゼロより大きく、バッファーの最初の 2 バイトは削除されたレコード数のカウントを提供します。
ポジショニング
Step Next Delete Extended オペレーションでは、カレンシーは確立しません。レコードが削除されると、現在の論理位置も物理位置も有効でなくなります。ただし、物理位置はアクセス可能であるため、Step Next オペレーションまたは Step Previous オペレーションを実行でき、その後有効な位置を持ちます。Get オペレーションによって削除されたレコードに達した場合は、次および前の論理位置も有効です。有効な現在の位置は、前述のオペレーションが呼び出されたとき、または Get Position（22）および Get Direct/Record（23）を使用することにより、使用可能になります。
次のリストは、選定されたステータス コードとフィルター条件の関係を示しています。
• ステータス 60（リジェクト カウントに達しました）：現在の位置は、フィルター条件に一致しないレコードです。
• ステータス 84（レコードまたはページはロックされています）：現在の位置は、フィルター条件に一致しない可能性のあるレコードです。また、次のレコードはフィルター条件に一致するが、ロックされているために削除できないという可能性もあります。
• ステータス 22（データ バッファーがいっぱいです）：現在の位置は、フィルター条件に一致するレコードです。ただし、データ バッファーにはレコード アドレスを書き込むためのスペースがないため、MicroKernel エンジンはそのレコードを削除しませんでした。
• ステータス 9（ファイルの終わり）：現在の位置は、論理的にも物理的にも無効です。
Step Previous（35）
Step Previous オペレーション（B_STEP_PREVIOUS）では、前の物理位置として示されるレコードを取得します。MicroKernel エンジンでは Step Previous オペレーションでレコードを取得するためにインデックス パスは使用されません。
Step Previous オペレーションを任意の Get または Step オペレーションの直後に実行すると、前のオペレーションで取得されたレコードの物理的に前にあるレコードが返されます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• 前の物理位置を確立しておくことが必要です。たとえば、Delete オペレーションの次に Step Previous オペレーションを実行することはできません。
手順
1. オペレーション コードを 35 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. データ バッファー長を、取得するレコードの長さ以上の値に設定します。
結果
Step Previous オペレーションが正常に終了した場合、MicroKernel エンジンではファイル内の前の物理レコードがデータ バッファーに返され、返されたバイト数がデータ バッファー長に設定されます。
このオペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Step Previous オペレーションを実行しても、論理カレンシーは確立しません。取得したレコードを現在の物理レコードとして使用し、物理カレンシーが設定されます。
Step Previous Delete Extended（88）
Step Previous Delete Extended オペレーション（B_STEP_PREV_EXT_DELETE）では、物理位置の直前からファイルの先頭へ向かって 1 つまたは複数のレコードを検索します。検索したレコードをフィルター条件と比較し、条件に一致するレコードを削除します。フィルター条件は論理式の形を取り、キー フィールドに限定されません。
このトピックで述べるように、このオペレーションが使用する入力および出力バッファー構造体、および返す結果は、
Get Next Extended（36）に記載されているものと同じです。詳細については、当該オペレーションを参照してください。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• 前の物理位置を確立しておくことが必要です。たとえば、Delete オペレーションの次に Step Previous Extended オペレーションを実行することはできません。
手順
1. オペレーション コードを 88 に設定します。
デフォルトでは、ロック バイアスはノーウェイトで、どのロック バイアス設定も無視されます。動作は +500 と同じです。エンジンは、ロックされたレコードを削除できない場合には、オペレーションを再試行しないで直ちに戻ります。
2. ファイルのポジション ブロックを渡します。
3. 入力構造体と戻り出力のどちらか大きい方を格納できるように、データ バッファーを指定します。
Get Next Extended（36）にある Extended オペレーションの入力バッファーの情報に従って、データ バッファーを初期化します。
詳細
Get Next Extended（36）の以下のトピックで、Extended オペレーションの入力バッファーの構造体とそのフィルター セグメントの使用について、さらに結果を返す出力バッファーの構造体について説明されています。
結果
このオペレーションでは、
Step Next Delete Extended（87）と同様の結果が返されます。詳細については、当該オペレーションを参照してください。
ポジショニング
Step Previous Delete Extended オペレーションでは、カレンシーは確立しません。レコードが削除されると、現在の論理位置も物理位置も有効でなくなります。ただし、物理位置はアクセス可能であるため、Step Next オペレーションまたは Step Previous オペレーションを実行でき、その後有効な位置を持ちます。Get オペレーションによって削除されたレコードに達した場合は、次および前の論理位置も有効です。有効な現在の位置は、前述のオペレーションが呼び出されたとき、または Get Position（22）および Get Direct/Record（23）を使用することにより、使用可能になります。
次のリストは、選定されたステータス コードとフィルター条件の関係を示しています。
• ステータス 60（リジェクト カウントに達しました）：現在の位置は、フィルター条件に一致しないレコードです。
• ステータス 84（レコードまたはページはロックされています）：現在の位置は、フィルター条件に一致しない可能性のあるレコードです。また、次のレコードはフィルター条件に一致するが、ロックされているために削除できないという可能性もあります。
• ステータス 22（データ バッファーがいっぱいです）：現在の位置は、フィルター条件に一致するレコードです。ただし、データ バッファーにはレコード アドレスを書き込むためのスペースがないため、MicroKernel エンジンはそのレコードを削除しませんでした。
• ステータス 9（ファイルの終わり）：現在の位置は、論理的にも物理的にも無効です。
Step Previous Extended（39）
Step Previous Extended オペレーション（B_STEP_PREVIOUS_EXT）では、物理位置の直前からファイルの先頭へ向かって 1 つまたは複数のレコードを検索します。検索したレコードをフィルター条件と比較し、条件に一致するレコードを取得します。フィルター条件は論理式の形を取り、キー フィールドに限定されません。
Step Previous Extended オペレーションでは、既存のレコードの中から指定したフィールドを抽出し、抽出したフィールドだけを含む新しいレコードのセットを返すこともできます。
このトピックで述べるように、このオペレーションが使用する入力および出力バッファー構造体、および返す結果は、
Get Next Extended（36）に記載されているものと同じです。詳細については、当該オペレーションを参照してください。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• 前の物理位置を確立しておくことが必要です。たとえば、Delete オペレーションの次に Step Previous Extended オペレーションを実行することはできません。
手順
1. オペレーション コードを 39 に設定します。任意でロック バイアスも指定できます。
• +100 - 単一レコード ウェイト ロック
• +200 - 単一レコード ノーウェイト ロック
• +300 - 複数レコード ウェイト ロック
• +400 - 複数レコード ノーウェイト ロック
レコード ロックおよびデータ整合性については、『
Zen Programmer's Guide』のほかに、『
Advanced Operations Guide』に記載されている Zen サーバーを設定するための
ウェイト ロック タイムアウト プロパティを参照してください。
2. ファイルのポジション ブロックを渡します。
3. 入力構造体と戻り出力のどちらか大きい方を格納できるように、データ バッファーを指定します。
Get Next Extended（36）にある Extended オペレーションの入力バッファーの情報に従って、データ バッファーを初期化します。
詳細
このオペレーションでは、
Get Next Extended（36）の場合と同じ入力バッファーおよび出力バッファーを使用します。詳細については、当該オペレーションを参照してください。
結果
このオペレーションでは、
Get Next Extended（36）と同様の結果が返されます。詳細については、当該オペレーションを参照してください。
ポジショニング
Step Previous Extended オペレーションを実行しても、論理カレンシーは確立しませんが、検索された最後のレコードが現在の物理レコードになります。このレコードは、フィルター条件を満たして取得されたレコードか、またはフィルター条件を満たさないために拒否されたレコードのいずれかです。
Stop（25）
Stop オペレーション（B_STOP）では、クライアントに対していくつかの終了ルーチンを実行します。終了ルーチンには、すべてのロックを解除する、開いているファイルでそのクライアントに関連付けられているファイルをすべて閉じるなどのルーチンがあります。
パラメーター
手順
オペレーション コードを 25 に設定します。
結果
Stop オペレーションが正常に終了した場合、MicroKernel エンジンでは次のような動作が実行されます。
1. 実行中のトランザクションがすべて中止されます。
2. クライアントによって保持されているすべてのロックが解除されます。
3. クライアントが開いているファイルがすべて閉じられます。
4. ほかのクライアント（MicroKernel エンジンに登録されているほかのアプリケーション）が存在しない場合、MicroKernel エンジンの設定にもよりますが、MicroKernel エンジンの実行が終了し、いくつかのリソースが解放されます。
Stop オペレーションが失敗した場合は、MicroKernel エンジンから 0 以外のステータス コードが返されます。最もよくあるのはステータス コード 20（MicroKernel または Btrieve リクエスターが非アクティブ）です。このステータスは、MicroKernel エンジンまたはリクエスターがロードされていないために発生します。
ポジショニング
Stop オペレーションを実行すると、開いているファイルがすべて閉じられるため、すべてのカレンシーが消去されます。
Unlock（27）
Unlock オペレーション（B_UNLOCK）では、明示的にロックされている 1 つまたは複数のレコード（つまり、ロック バイアス +100、+200、+300 または +400 を使ってロックされたレコード）のロックを解除します。Unlock オペレーションは指定したポジション ブロックで保持されているロックを解除します。そのため、同一ファイルを複数回開いた場合は、ポジション ブロックごとに Unlock オペレーションを発行しなければ、レコードのロックは完全に解除されません。同様に、ファイル内のレコードに対しロックを保持している各クライアントが Unlock オペレーションを発行しなければ、レコードのロックは完全に解除されません。
パラメーター
前提条件
少なくとも 1 つのレコードがロックされていることが必要です。
手順
単一レコード ロックを解除するには
1. オペレーション コードを 27 に設定します。
2. ロックされたレコードを含むファイルのポジション ブロックを渡します。
3. キー番号を負でない値に設定します。
複数レコード ロックが設定されている 1 つのレコードのロックを解除するには
1. そのレコードを対象に Get Position（22）を発行し、ロックを解除するレコードの 4 バイトまたは 8 バイトの物理位置を取得します。その後、次の手順に進んで Unlock オペレーションを発行します。
2. オペレーション コードを 27 に設定します。
3. ロックされたレコードを含むファイルのポジション ブロックを渡します。
4. Get Position（22）から返される 4 バイトまたは 8 バイトの物理位置をデータ バッファーに格納します。Get Position と Unlock では同じ BTRV または BTRVEX タイプのエントリ ポイントを使用して、レコード アドレス サイズに一貫性を持たせるようにしてください。
5. データ バッファー長を 4 または 8 に設定します。
6. キー番号パラメーターを -1 に設定します。
ファイル上の複数レコード ロックをすべて解除するには
1. オペレーション コードを 27 に設定します。
2. 複数のロックを含むファイルのポジション ブロックを渡します。
3. キー番号パラメーターを -2 に設定します。
結果
Unlock オペレーションが正常に終了した場合、MicroKernel エンジンではオペレーションで指定したロックがすべて解除されます。
Unlock オペレーションが失敗した場合は、MicroKernel エンジンから 0 以外のステータス コード、たいていはステータス コード 81 が返されます。
ポジショニング
Unlock オペレーションは、ポジショニングにまったく影響しません。
Update（3）
Update オペレーション（B_UPDATE）では、既存のレコードの情報を変更します。
パラメーター
メモ： NCC（No-currency-change：カレンシー変更なし）オプションを使用すると、Update オペレーションはキー バッファー パラメーターの値を更新しません。つまり、このパラメーターには何の情報も返されません。
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルの物理カレンシーを確立しておくことが必要です。Extended Get、Extended Step、または Get Key オペレーションでも物理カレンシーは確立しますが、これらのオペレーションの後に Update オペレーションを実行することはできないことに留意してください。
手順
1. オペレーション コードを 3 に設定します。
2. レコードを含むファイルのポジション ブロックを渡します。
3. データ バッファーに更新後のデータ レコードを格納します。
4. データ バッファー長を更新後のレコードの長さに設定します。
5. レコードの取得に使用したキー番号を設定します。NCC オプションを使用するには、キー番号に -1 を指定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
Get オペレーションの直後に NCC オプションを使用しない Update オペレーションを実行するときは、Get オペレーションで MicroKernel エンジンから返されたものとまったく同じキー番号を渡します。そうしないと、MicroKernel エンジンでレコードは正常に更新されますが、更新後に実行する最初の Get オペレーションでステータス コード 7 が返されます。
結果
Update オペレーションが正常に終了した場合、MicroKernel エンジンではファイル内に格納されているレコードがデータ バッファー内の新しい値を使って更新され、キー値の変更を反映してインデックスが調整されます。また、指定したキーの値がキー バッファーに返されます。NCC Update オペレーションでは、キー バッファー パラメーターの値は更新されません。
MicroKernel エンジンでは、アプリケーションが更新するレコードに単一レコード ロックを設定している場合は、ロックが解除されます。しかし、複数レコード ロックは Update オペレーションを実行しても解除されません。
Update オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Update オペレーションも NCC Update オペレーションも、物理カレンシーには影響しません。
NCC オプションを使用しない Update オペレーションでは、更新されたキーの値によってインデックス内のレコードが再配置される場合には論理カレンシーに影響を与えることがあります。たとえば、INTEGER キーについて、現在の論理レコードは値 1 を持つとします。これと同じキーについて、次の論理レコードは値 2 を持ちます。このとき 1 を 4 に更新すると、次の論理レコードが変わります。この例では、Update オペレーションの実行後、次の論理レコードは 4 よりも大きい値を持つことになります。
NCC Update オペレーションは論理カレンシーに影響しません。つまり、NCC Update オペレーションを実行したアプリケーションでは、ファイル内の論理位置は Update オペレーションを実行する前と変わらないということです。このような状況で、NCC Update オペレーションに続けて、Get Next（6）、Get Next Extended（36）、Get Previous（7）、および Get Previous Extended（37）などのオペレーションを実行すると、NCC Update オペレーション実行以前のアプリケーションの論理カレンシーに基づく値が返されます。
メモ： MicroKernel エンジンでは、NCC Update オペレーションを実行しても、その結果として何の情報もキー バッファーには返されません。したがって、論理カレンシーの維持が必要なアプリケーションでは、NCC Update オペレーション後にキー バッファーの値を変更しないでください。変更すると、次の Get オペレーションの結果は予測できないものになります。
Update Chunk（53）
Update Chunk オペレーション（B_CHUNK_UPDATE）では、レコードの 1 つまたは複数の部分（チャンク）の情報を変更できます。また、既存のレコードに情報を追加してレコードを長くしたり、既存のレコードを指定したオフセットで切り詰めることもできます。
パラメーター
前提条件
• 対象となるファイルが開いていることが必要です。
• ファイルの現在の物理レコードまたは論理レコードを確立しておくことが必要です。
メモ： Extended オペレーションまたは Get Key（+50）オペレーションでも必要な位置は確立しますが、これらのオペレーションの直後に Update Chunk オペレーションを発行することはできません。それは、これらのオペレーションでは単独のレコードが返されないからです。
手順
1. オペレーション コードを 53 に設定します。
2. レコードを含むファイルのポジション ブロックを渡します。
3. 詳細の説明に従って、データ バッファーを指定します。
4. データ バッファー長を、データ バッファーに格納するバイト数以上の値に設定します。データ バッファー長の計算の詳細については、
詳細を参照してください。
5. レコードの取得に使用したキー番号をキー番号パラメーターに設定します。システム定義のログ キー（システム データとも呼ばれる）を使用するには、125 を指定します。システム データ v2 用の 2 番目のシステム キーを使用するには、124 を指定します。
詳細
データ バッファーでは、次のチャンク ディスクリプターのいずれかを使用します。
• ランダム チャンク ディスクリプター - オペレーションに付き 1 つのチャンクを更新するため、またはチャンクがレコード全体にわたってランダムに配置されているときに、1 回のオペレーションで複数のチャンクを更新するために使用します。
• 矩形チャンク ディスクリプター - 各チャンクの長さが同じで、チャンクがレコード内に等間隔に配置されているときに、1 回のオペレーションで複数のチャンクを更新するために使用します。
• 切り捨てチャンク ディスクリプター - 指定されたオフセットでレコードを切り捨てるために使用します。
ランダム チャンク ディスクリプター構造体
次の例は、ランダムに配置されている 3 つのチャンク（[*] がある部分）を含むレコードを示しています。チャンク 0（バイト 0x12 から 0x16）、チャンク 1（バイト 0x2A から 0x31）、およびチャンク 2（バイト 0x41 から 0x4E）です。
ランダム チャンク ディスクリプターを定義するには、次の表に基づいてデータ バッファーに構造体を作成する必要があります。
次の表は、32 ビット アプリケーション用の直接ランダム チャンク ディスクリプター構造体の例を示しています。
矩形チャンク ディスクリプター構造体
同じ長さのチャンクがレコード全体にわたって等間隔に配置されている場合は、矩形チャンク ディスクリプターを使って、更新するすべてのチャンクを記述することができます。たとえば、次のような図を考えてみましょう。この図は、レコード内のオフセット 0x00 から 0x4F までを表しています。
このレコードには 3 つのチャンク（[*] がある部分）が含まれています。チャンク 0（バイト 0x19 から 0x1C）、チャンク 1（バイト 0x29 から 0x2C）、およびチャンク 2（バイト 0x39 から 0x3C）です。各チャンクはどれも 4 バイトの長さで、チャンク同士は、各チャンクの先頭から計算すると、いずれも合計 16（0x10）バイトずつ離れています。
1 つの矩形ディスクリプターを使って、3 つのチャンクをすべて更新できます。矩形チャンクを更新するには、次の表に基づいてデータ バッファーに構造体を作成する必要があります。
矩形がメモリ内にあるとき、各行の間隔がレコードとして格納されているときと同じバイト数になる場合は、アプリケーションの行間隔を行間隔と同じ値に設定します。しかし、矩形がアプリケーション メモリ内で再配置され、行の間隔が何バイトか増減する場合は、アプリケーションの行間隔により、その情報を MicroKernel エンジンに渡すことができます。
間接矩形ディスクリプターを使用するときは、MicroKernel エンジンはユーザー データ要素およびアプリケーションの行間隔要素を使って、更新のためにデータを読み取る場所を決定します。MicroKernel エンジンは先頭行のデータを、ユーザー データのオフセット 0 から読み取ります。MicroKernel エンジンは 2 行目のデータを、ユーザー データ + アプリケーションの行間隔で指定されるアドレスから読み取ります。MicroKernel エンジンは 3 行目のデータを、ユーザー データ + (アプリケーションの行間隔 * 2) で指定されるアドレスに格納します。以下同様です。
次の表は、32 ビット アプリケーション用の直接矩形チャンク ディスクリプター構造体の例を示しています。
切り捨てディスクリプター構造体
切り捨てディスクリプターを使うと、指定したオフセットでレコードを切り捨てることができます。この種類のチャンク ディスクリプターを使用するには、次の表に基づいてデータ バッファーに構造体を作成する必要があります。
ネクストインレコード サブファンクション バイアス
これまでに述べたサブファンクションの値にバイアス 0x40000000 を加算すると、MicroKernel エンジンではレコード内の物理カレンシー（つまり、レコード内の現在の物理位置）に基づいてサブファンクションのオフセット要素の値が算出されます。ネクストインレコード サブファンクションを使用する場合、MicroKernel エンジンではチャンク ディスクリプターのオフセット要素は無視されます。
このバイアスをランダム チャンク ディスクリプターと組み合わせて使用し、1 回のオペレーションで複数のチャンクを更新する場合、MicroKernel エンジンでは前のチャンクの長さに前のチャンクのオフセットが加算され、先頭のチャンクを除くすべてのチャンクに対するオフセットが自動的に計算されます。つまり、ネクストインレコード バイアスは、オペレーションの対象となるすべてのチャンクに適用されるということです。
追加サブファンクション バイアス
バイアス 0x20000000 をランダム チャンク ディスクリプターのサブファンクションまたは矩形チャンク ディスクリプターのサブファンクションの値に加算すると、MicroKernel エンジンではそのサブファンクションのオフセット要素の値がレコードの末尾の次のバイトとなるように計算されます。
メモ： このバイアスは、ネクストインレコード バイアスまたは切り捨てサブファンクションと共に使用しないでください。
MicroKernel エンジンで、このバイアスをランダム チャンク ディスクリプターと組み合わせて使用し、1 回のオペレーションで複数のチャンクを更新する場合、MicroKernel エンジンでは前のチャンクの追加後のレコードの長さに基づいて、先頭のチャンクを除くすべてのチャンクに対するオフセットが自動的に計算されます。
結果
Update Chunk オペレーションが正常に終了した場合、MicroKernel エンジンではデータ バッファーのチャンク ディスクリプター部分でチャンクとして識別されたレコードの部分が更新されます。チャンクを更新するための新しいデータは、直接チャンク ディスクリプターのサブファンクションを使用した場合はチャンク ディスクリプター自体に、間接チャンク ディスクリプターのサブファンクションを使用した場合は、各チャンクのユーザー データ要素の 32 ビット ポインターで指定されたメモリ アドレスに格納されています。Update Chunk オペレーションが完了すると、MicroKernel エンジンではキー値の変更を反映してキー インデックスが調整され、必要に応じてキー バッファー パラメーターが更新されます。
さらに、アプリケーションが更新するレコードに単一レコード ロックを設定している場合は、MicroKernel エンジンではロックが解除されます。しかし、複数レコード ロックは Update Chunk オペレーションを実行しても解除されません。
Update Chunk オペレーションが失敗した場合は、MicroKernel エンジンから次のステータス コードのいずれかが返されます。
ポジショニング
Update Chunk オペレーションを実行しても、物理カレンシーおよび現在の論理レコードは変わりません。
メモ： Get オペレーションに続けて Update Chunk オペレーションを実行する場合は、直前の Get オペレーションで指定したキー番号と異なる値を Update Chunk オペレーションに渡さないでください。異なるキー番号を渡すと、MicroKernel エンジンによって確立されるポジショニングが予測できないものになります。
Version（26）
クライアント アプリケーションの場合、Version オペレーション（B_VERSION）では、ローカルの MicroKernel エンジンのバージョンおよび、適用可能であれば、リクエスターのバージョンが返されます。また、クライアント アプリケーションがサーバー上のファイルを開いていたり、キー バッファーにサーバー ファイル パス名を指定していると、そのサーバー上で実行されている MicroKernel エンジンのバージョンも返されます。サーバーベース アプリケーションの場合は、サーバーベース MicroKernel エンジンのバージョンおよびリビジョン番号が返されます。
パラメーター
前提条件
Version オペレーションを発行するには、MicroKernel エンジンまたはリクエスターのどちらかがロードされていることが必要です。
手順
1. オペレーション コードを 26 に設定します。
2. データ バッファー長を少なくとも 15 に設定します。詳細については、
結果を参照してください。
3. サーバーベース MicroKernel エンジンのバージョン番号を取得するには、そのサーバー上で開いているファイルの有効なポジション ブロックを指定するか、キー バッファーに有効なパス名を指定する必要があります。
結果
ワークステーション MicroKernel エンジンとクライアント リクエスターの両方にアクセスできるように環境設定されており、Version オペレーションが正常に終了した場合は、ワークステーション MicroKernel エンジン、クライアント リクエスター、およびサーバーベース MicroKernel エンジンのバージョン情報が返されます。
この場合、15 バイトのデータ バッファーとデータ バッファー長を指定してください。
クライアント リクエスターとワークステーション MicroKernel エンジンの両方がロードされており、データ バッファーとデータ バッファー長に 5 バイトしか指定していないと、クライアント リクエスターのバージョン情報だけが返されます。
10 バイトしか指定してしない場合は、クライアント リクエスターとローカル ワークステーション エンジンが返されます。
データ バッファーとデータ バッファー長に 15 バイトを指定した場合は、クライアント リクエスター、ローカル ワークステーション エンジン、およびサーバー エンジン（適用可能な場合）が返されます。
データ バッファーには、次の表の形式に従って、Version オペレーションから MicroKernel エンジンまたはリクエスターごとに 5 バイトのバージョン ブロックが返されます。各ブロックの 5 バイト目により、それぞれの MicroKernel エンジンまたはリクエスターを識別できます。
たとえば、Windows サーバーで Zen 14.10 を実行している場合は、データ バッファーに次のような 16 進の値が返されます。
0E 00 0A 00 54
これらの値を 10 進に変換すると、バージョン番号は 14 で、リビジョン番号は 10 になります。Version オペレーションが失敗した場合は、MicroKernel エンジンから 0 以外のステータス コードが返されます。
ポジショニング
Version オペレーションは、ポジショニングにまったく影響しません。