Btrieve API の紹介
PSQL MicroKernel エンジンは、高パフォーマンスなデータ処理とプログラミングの生産性向上を目的として設計されています。MicroKernel エンジン オペレーションを使用すると、開発アプリケーションではキー値、あるいはシーケンシャルまたはランダム アクセス方法に基づいて、レコードの取得、挿入、更新、または削除が行えるようになります。
Btrieve API は、以下のプログラミング言語および開発環境と互換性があります。
以下のセクションで API の機能について説明します。
Btrieve API オペレーションの一覧または Btrieve オペレーションのクィック リファレンスへ直接移動することもできます。
Btrieve API 関数
Btrieve API は単一関数です。この API では、ほとんどのプログラム動作が関数名ではなくオペレーション コード パラメーターによって決定されます。アプリケーションで使用する API は、異なるプラットフォーム間でのコードの移植性を重視するか、特定のプラットフォームで可能な限り最高のパフォーマンスを重視するかを基準として選択してください。
Btrieve アプリケーションでは、データ ファイルに対して絶対に標準の I/O を実行しないでください。開発するアプリケーションでは、Btrieve API 関数を使って、すべてのファイル I/O を実行する必要があります。
次に、Btrieve API 関数の一覧を示します。
Btrieve API 関数を呼び出す場合に必要となる言語固有の構文を調べるには、『PSQL Programmer's Guide』の Btrieve API プログラミングを参照してください。
BTRV 関数
BTRV によって、アプリケーションは MicroKernel エンジン呼び出しを実行できるようになります。BTRV 関数は、プログラミング インターフェイスのインストール オプションで提供されるすべての言語インターフェイス モジュールでサポートされています。場合によって、BTRV 関数は実際に BTRCALL 関数を呼び出すことがあります。しかしながら、プラットフォームに依存しないということから、BTRV 関数の方がより好ましいでしょう。
BTRVID 関数
BTRVID によって、アプリケーションはクライアント ID パラメーターを含む単独の MicroKernel エンジン呼び出しを実行できるようになります。このパラメーターはアプリケーションで制御できます。アプリケーションでは BTRVID を使って、自分自身を MicroKernel エンジンに対する複数のクライアント ID として割り当て、ほかのクライアントの状態に影響を与えることなく、各クライアントのオペレーションを実行することができます。詳細については、クライアント ID を参照してください。
DOS アプリケーションでは、/T オプションに適切な値を指定して DOS リクエスターをロードする必要があります。/T には、アプリケーション内で使用するクライアント ID の数に等しい値を設定します。DOS リクエスタの詳細については、『Getting Started with PSQL』を参照してください。
BTRCALL 関数
Windows、Linux、および OS X の場合、BTRCALL および BTRCALL32 は BTRV 関数に相当します。BTRV で発生する若干のパフォーマンス低下が問題にならない限り、BTRCALL ではなく BTRV 関数を使用するようにしてください。
BTRCALLID 関数
クライアント レベルの制御が必要で、アプリケーションが Windows、Linux、または OS X で動作する場合は、BTRCALLID 関数を使用します。
中間関数を呼び出さないこと以外は、この関数は BTRVID 関数に類似しています。
BTRCALLID32 関数
BTRCALLID32 関数は BTRCALLID 関数と同じです。
旧バージョンの関数
次の関数は、以前のバージョンの Btrieve API に対応して作成された古いアプリケーションとの互換性を維持するためだけにサポートされています。
現在のバージョンではこれらの関数を使用しませんが、これらの関数を呼び出す古いアプリケーションは v6.15 以降の MicroKernel でも正常に実行されます。
Btrieve API 関数のパラメーター
呼び出しのたびにすべてのパラメーターを入力する必要がありますが、MicroKernel エンジンではオペレーションのたびにすべてのパラメーターが使用されるわけではありません。場合によっては、MicroKernel エンジンではそれらの値が無視されます。一般に、それぞれのオペレーションでは異なるパラメーターが送られ、返されます。第 2Btrieve API オペレーションで、各 Btrieve API オペレーションに関連するパラメーターについて詳しく説明します。
メモ: C 開発者:C 言語インターフェイスで使用されるプラットフォームに依存しないデータ型とポインターについては、BTITYPES.H を参照してください。
Btrieve API 関数のパラメーターを以下に示します。
ステータス コード(BASIC と COBOL のみ)
クライアント ID(BTRVID と BTRCALLID 関数のみ)
キー長(BTRCALL、BTRCALLID、BTRCALL32、BTRCALLID32 関数のみ)
オペレーション コード
オペレーション コード パラメーターは、Btrieve API 関数によって実行される動作を決定します。たとえば、1 つまたは複数のレコードの読み取り、書き込み、削除、更新などのオペレーションです。アプリケーションでは、すべての Btrieve API 呼び出しに対して有効なオペレーション コードを指定する必要があります。MicroKernel エンジンがオペレーション コードを変更することはありません。指定する変数の値は、第 2Btrieve API オペレーションに示されている Btrieve API の正しいオペレーション コードのいずれかでなければなりません。
メモ: C 開発者:指定する変数は BTI_WORD 型(符号なし short integer)でなければならず、値渡しする必要があります。
ステータス コード
MicroKernel エンジンは、符号付き整数としてステータス コードを返します。ほとんどのプログラミング環境で、ステータス コードは Btrieve API 関数呼び出しの戻り値です。ただし、一部の BASIC および COBOL 言語インターフェイスでは、ステータス コード パラメーターが必要となります。このパラメーターは 2 バイトの整数で、オペレーションの実行中に何らかのエラーが発生したかどうかを示すコード化された値を含みます。Btrieve API 呼び出しの終了後、アプリケーションではステータス変数の値を必ずチェックし、その呼び出しが正常に終了したかどうかを確認する必要があります。
PSQL コンポーネントによって、呼び出しから API へステータス コードが返されます。これらの API に書き込む場合は、以下の 3 つの状態に対して処理を行う必要があります。
以下は、3 つすべての状態を処理する C コードの例です。
 
status = BTRVID(B_VERSION, posBlock1, &versionBuffer, &dataLen, keyBuf1, keyNum, (BTI_BUFFER_PTR) &clientID);
if (status == B_NO_ERROR)
{
    /* 通常のオペレーションを続行 */
    status = BTRVID(...);
}
else if (status == B_RECORD_MANAGER_INACTIVE)
{
    /* 予期されたエラーの処理 */
    printf("Btrieve Get Version() returned B_RECORD_MANAGER_INACTIVE\n");
}
else
{
    /* 予期されなかったエラー */
    printf("Btrieve Get Version() returned %d\n", status);
} /* 別の場合は終了 */
このステータス コードの処理方法に従うと、アプリケーションの将来的な安定性を確保する上で役立ちます。Actian Corporation は、製品を改良し続けるために、開発者からのフィードバックを奨励し、これを反映させています。
ポジション ブロック
ポジション ブロック パラメーターは、128 バイト配列のアドレスで、MicroKernel エンジンがファイル I/O 構造体や Open(0)オペレーションに関連するポジショニング情報を格納するために使用されます。アプリケーションは、ファイルを開くたびに固有のポジション ブロックを割り当てる必要があります。
MicroKernel エンジンは、アプリケーションが Open オペレーションを実行する際にポジション ブロックを初期化し、その後ファイルの操作中にこのポジション ブロックを参照して更新します。このため、アプリケーションでは、そのファイルに対する以降すべての Btrieve API オペレーションで同じポジション ブロックを指定する必要があります。
メモ: ポジション ブロックへの書き込みを行ってはいけません。書き込みを行うと、ポジション喪失エラーやその他のエラー、あるいはファイルの損傷などの原因となります。
一度に複数のファイルを開く場合、MicroKernel エンジンはポジション ブロックを使って、特定の呼び出しで対象となるファイルを判別します。同様に、同じファイルを複数回開く場合、MicroKernel エンジンは Open オペレーションごとにそれぞれ異なるポジション ブロックを使用します。さらに、MicroKernel エンジンは、同じファイルを開くクライアントごとにも別個のポジション ブロックを使用します。複数のクライアントでポジション ブロックを共有することはできません。
データ バッファー
アプリケーションでファイルとデータをやり取りする場合は、データ バッファーを使用します。データ バッファーを使って MicroKernel エンジンとの間でやり取りされる情報は、実行される Btrieve API オペレーションによって異なります。しばしば、データ バッファーには、アプリケーションとファイルの間で相互に転送される 1 つまたは複数のレコードが格納されています。しかし、Btrieve API オペレーションによっては、ファイル仕様やキー仕様、MicroKernel エンジンのバージョン情報など、その他の情報がデータ バッファーに格納されることもあります。
必ず、ファイル内の最長レコードを収容できるだけの長さのデータ バッファーを割り当ててください。データ バッファーの割り当てサイズよりも大きな値をデータ バッファー長パラメーターに指定した場合、MicroKernel エンジン変更オペレーションによって、データ バッファーの後に続くデータが破壊される可能性があります。
データ バッファー長
データ バッファーを必要とするオペレーションでは、アプリケーションはデータ バッファーのサイズ(バイト単位)を示す変数を渡す必要があります。このデータ バッファーは、オペレーションによって返されるデータを十分格納できるだけの大きさでなければなりません。
メモ: BASIC 開発者:データ バッファー長パラメーターとして、長整数の ByRef を渡す必要があります。

C、COBOL、Pascal の開発者:データ バッファー長パラメーターとして、2 バイトの符号なし整数へのポインターを渡す必要があります。
可変長レコードを含むファイルにレコードを挿入したり、そのファイルを更新したりする場合、データ バッファー長は、ファイルを最初に作成したときに指定したレコード長に、固定長部分を超えて含まれる文字数を加算した値と等しくなければなりません。可変長レコードを取得する場合、データ バッファー長はファイル内の最長レコードに対応できる長さである必要があります。1 件のレコードが 64 KB より長い場合は、レコードの部分を操作するためにチャンク オペレーションを使用する必要があります。
MicroKernel エンジンはデータ バッファー長パラメーターによって、データ バッファーに使用可能なスペース量を判断します。割り当てたデータ バッファーより長いデータ バッファー長を渡すと、MicroKernel エンジンによってメモリが上書きされる場合があります。データ バッファー長は、実際に割り当てられたデータ バッファーのサイズを常に正確に表すようにしてください。
キー バッファー
Btrieve API オペレーションでキー バッファーが使用されない場合でも、アプリケーションは各 Btrieve オペレーションにキー バッファー パラメーターを渡す必要があります。オペレーションによっては、アプリケーションがキー バッファーのデータを設定する場合や、Btrieve API 関数がこれを返す場合があります。
メモ: BASIC 開発者:キー バッファー パラメーターとして文字列を渡す必要があります。キー値が整数である場合、アプリケーションでは Btrieve API 関数を呼び出す前に、MKI$ ステートメントを使用してキー値を文字列に変換しておく必要があります。キーが複数のセグメントから構成されている場合は、それらを結合して 1 つの文字列変数にし、その変数をキー バッファーとして渡す必要があります。

キー バッファーとして渡した文字列変数がキーの定義された長さより短い場合、MicroKernel エンジンからエラーが返されます。アプリケーションの最初の呼び出しがキー バッファーの初期化を必要としない場合は、文字列変数に SPACE$(x) の値を割り当てます。この x は、キーの定義されている長さを表します。アプリケーションが文字列変数に BASIC の何らかの値を割り当てるまで、その長さは 0 になります。

C 開発者:キー バッファー パラメーターとしてキー値を含む変数のアドレスを渡す必要があります。BTITYPES.H ファイルは、キー バッファーを VOID ポインター(BTI_VOID_PTR)として定義しています。キー バッファーのデータ型は、必要に応じてアプリケーションで定義できます。

COBOL 開発者:キー バッファー パラメーターとしてレコード変数を渡す必要があります。キーが複数のセグメントから構成されている場合は、01 レベルのレコード下の個別フィールドとして、それらを正しい順序でリストします。これで、レコード全体をキー バッファーとして渡すことができます。

Pascal 開発者:キー バッファー パラメーターとしてキー値を含む変数を渡す必要があります。キーが複数のセグメントから構成されている場合は、レコード構造体を使ってキーに含まれる個々のフィールドを定義します。
ほとんどの環境で、アプリケーションが Btrieve API 呼び出しを実行するとき、MicroKernel エンジンはキー バッファー長を決めることができません。このため、バッファーは少なくとも、キーを最初に作成したときに指定したキー長と同じだけの長さがあるようにしてください。そうでないと、Btrieve API オペレーションにより、メモリ内でキー バッファーの後に格納されているデータが破壊される可能性があります。キーの最大長は 255 なので、常に 255 バイトのキー バッファーにすることをお勧めします。
キー番号
キー番号パラメーターで渡される情報は、実行しているオペレーションによって異なります。ほとんどの場合、キー番号には、特定のオペレーションが最高 119 あるキー(アクセス)パスのうちのどれに従っているかを示す値が含まれます。しかし、ファイルを開くときのモードを示す値など、その他の情報がキー番号パラメーターから渡されたり、キー番号パラメーターに返される場合もあります。
BTRV および BTRVID 関数では、キー番号パラメーターは 2 バイト整数です。BTRCALL、BTRCALLID、BTRCALL32、および BTRCALLID32 関数では、キー番号パラメーターは 1 バイトの符号付き文字(BTI_CHAR)です。すべての関数で、キー番号パラメーターは 0 から 118 までの範囲の値となります。Btrieve API 関数がキー番号パラメーターを変更することはありません。
クライアント ID
クライアント ID パラメーターは、BTRVID 関数および BTRCALLID 関数でのみ使用されます。クライアント ID パラメーターは、MicroKernel エンジンがコンピューター上のクライアントを区別できるようにする 16 バイト構造体のアドレスです。クライアント ID には次のような構造体を使用します。
キー長
キー長パラメーターは、BTRCALL、BTRCALLID、BTRCALL32 および BTRCALLID32 関数でのみ使用されます。
これらの関数を使用する場合は、キー長パラメーターとして、割り当てられたキー バッファー長の値を含む符号なしの文字(BTI_BYTE)を渡す必要があります。指定できる最大長は 255 です(キーの最大長)。
Btrieve API オペレーションの要約
Btrieve API には、アプリケーション プログラムから呼び出せる 40 以上のオペレーションが用意されています。以下の表に、これらのオペレーションの要約を示します。詳細については、Btrieve API オペレーションを参照してください。オペレーション コード順の簡単な説明については、Btrieve オペレーションのクィック リファレンスを参照してください。
セッション固有のオペレーション
次のオペレーションを使用すると、現在のディレクトリの設定と取得、ワークステーション MicroKernel エンジンのシャットダウン、MicroKernel エンジン バージョン番号の取得、サーバー MicroKernel エンジンに接続されているクライアントの終了、トランザクションの開始、終了または中止といった処理を実行できます。複数のクライアントを処理するアプリケーションでは、これらのオペレーションは呼び出し元のクライアントに固有のものとなります。
ファイル固有のオペレーション
次のオペレーションは特定のファイルを取り扱います。このため、操作対象となるファイルを識別するためにポジション ブロック パラメーターが使用されます。ファイル固有のオペレーションは次の 3 つのタイプに分類されます。
ファイル アクセスと情報。これらのオペレーションでは、ファイルの作成、ファイルの開閉、ファイル統計情報の取得、ファイルのオーナー ネームの設定と削除、ファイルに対する Continuous オペレーション モードの開始と終了、ファイルのロック解除、ファイルに対するインデックスの作成と削除といった処理を実行できます。
データ取得。これらのオペレーションでは、指定した条件に基づいて単一レコードまたはレコードのセットを取得することができます。Btrieve API は、インデックス パスによる論理的位置、または物理的位置に基づくデータ検索をサポートしています。詳細については、『PSQL Programmer's Guide』の「レコードへのアクセス」を参照してください。
さらに、オペレーション コードにバイアスを適用して、マルチクライアント状況にあるファイルやレコードのロックを制御することもできます。詳細については、『PSQL Programmer's Guide』の「複数のクライアントのサポート」を参照してください。
データ操作。これらのオペレーションでは、データの挿入、更新、または削除が行えます。
 
 
 
サポートされないオペレーション
MicroKernel エンジン トレースや SDK ヘッダー ファイルを見たときに Btrieve API オペレーションのリファレンスに記載されていないオペレーションがあるかもしれません。これらは PSQL が内部的に使用するもので、アプリケーションで使用する必要はありません。以下に示すオペレーションはサポートされません。
 
Btrieve API オペレーションの実行における一連のイベント
1
2
将来の互換性を維持するため、使用するかどうかに関係なく、すべてのパラメーターを初期化してください。INTEGER 型のパラメーターの場合、値をバイナリ 0 に設定します。文字列配列の場合、バッファーへのポインターを渡します。この場合は、バッファーの先頭バイトをバイナリ 0 に初期化します。
3
4