JetGotoBookmark 関数

適用対象: Windows |Windows Server

JetGotoBookmark 関数

JetGotoBookmark 関数は、指定したブックマークに関連付けられているレコードのインデックス エントリにカーソルを置きます。 ブックマークは、テーブルに対して定義されている任意のインデックスで使用できます。 レコードのブックマークは、 JetGetBookmark を使用して取得できます。

    JET_ERR JET_API JetGotoBookmark(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          void* pvBookmark,
      __in          unsigned long cbBookmark
    );

パラメーター

sesid

この呼び出しに使用するセッション。

tableid

この呼び出しに使用するカーソル。

pvBookmark

カーソルの位置を指定するために使用するブックマークを含むバッファー。

cbBookmark

バッファー内のブックマークのサイズ。

戻り値

この関数は、次のいずれかの戻りコードを 使用して、JET_ERR データ型を返します。 考えられる ESE エラーの詳細については、「 拡張ストレージ エンジン エラー と エラー処理パラメーター」を参照してください。

この関数が成功すると、指定したブックマークに関連付けられているレコードのインデックス エントリにカーソルが配置されます。 レコードが更新用に準備されている場合、その更新は取り消されます。 インデックス範囲が有効な場合、そのインデックス範囲は取り消されます。 カーソルの検索キーが作成されている場合、その検索キーは削除されます。 データベースの状態に対する変更は行われません。

この関数が失敗した場合、カーソルの位置は変更されません。 レコードが更新用に準備されている場合、その更新は取り消されます。 インデックス範囲が有効な場合、そのインデックス範囲は取り消されます。 カーソルの検索キーが作成されている場合、その検索キーは削除されます。 データベースの状態に対する変更は行われません。

注釈

ブックマークを使用してインデックスにカーソルを置くには、2 つの方法があります。 1 つ目は、ブックマークを使用してレコードに直接配置することです。 これは、カーソルの現在のインデックスがプライマリ インデックスである場合に発生します。 この手法は、ESENT ブックマークが関連付けられているレコードの主キーと同じであるために機能します。

ブックマークを使用する 2 つ目の方法は、そのブックマークに関連付けられているレコードに対応するセカンダリ インデックス内のエントリにブックマークを配置することです。 このプロセス中、エンジンはプライマリ インデックスのブックマークを使用して実際のレコードを検索します。 次に、レコード データとセカンダリ インデックス定義を使用して、レコードを指すセカンダリ インデックスにキーを計算します。 次に、そのキーのインデックス エントリにカーソルを置きます。 カーソルが現在、1 つ以上の複数値キー列のセカンダリ インデックス上にある場合、カーソルは、これらの各キー列の最初の複数値に対応するインデックス エントリに配置されます。

要件

参照

JET_ERR
JET_SESID
JET_TABLEID
JetGetBookmark