JetGotoSecondaryIndexBookmark 関数

[アーティクル]
06/13/2023

適用対象: Windows |Windows Server

JetGotoSecondaryIndexBookmark 関数

JetGotoSecondaryIndexBookmark 関数は、指定されたセカンダリインデックスブックマークに関連付けられているインデックスエントリにカーソルを置きます。セカンダリインデックスブックマークは、最初に取得されたのと同じテーブルに対して同じインデックスで使用する必要があります。インデックスエントリのセカンダリインデックスブックマークは、 JetGotoSecondaryIndexBookmark を使用して取得できます。

Windows XP:JetGotoSecondaryIndexBookmark は Windows XP で導入されています。

    JET_ERR JET_API JetGotoSecondaryIndexBookmark(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          void* pvSecondaryKey,
      __in          unsigned long cbSecondaryKey,
      __in_opt      void* pvPrimaryBookmark,
      __in          unsigned long cbPrimaryBookmark,
      __in          const JET_GRBIT grbit
    );

パラメーター

sesid

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

tableid

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

pvSecondaryKey

カーソルの位置を指定するために使用するセカンダリキーを含むバッファー。

cbSecondaryKey

バッファー内のセカンダリキーのサイズ。

pvPrimaryBookmark

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

cbPrimaryBookmark

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

grbit

次のオプションの 0 個以上を指定するビットのグループ。

値	説明
JET_bitBookmarkPermitVirtualCurrency	インデックスエントリが見つからない場合は、そのインデックスエントリが以前に見つかった場所にカーソルが置かれます。操作は引き続きJET_errRecordDeletedで失敗します。ただし、不足しているインデックスエントリを基準にして、次または前のインデックスエントリに移動できます。

戻り値

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

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errClientRequestToStopJetService	JetStopService の呼び出しの結果、セッションに関連付けられているインスタンス上のすべてのアクティビティが停止したため、操作を完了できません。
JET_errInstanceUnavailable	セッションに関連付けられているインスタンスで致命的なエラーが発生したため、操作を完了できません。これは、そのデータの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したためです。 Windows XP: この戻り値は Windows XP で導入されています。
JET_errInvalidBookmark	指定されたセカンダリインデックスブックマークが無効でした。このエラーは、セカンダリキーが 0 であるか、セカンダリキーバッファーポインターが NULL であるために発生した可能性があります。このエラーは、次の理由で発生します。現在のセカンダリインデックスには一意性制約がないため、指定されたブックマークのサイズは 0 です。ブックマークバッファーポインターが NULL です。
JET_errNoCurrentIndex	カーソルは現在セカンダリインデックス上にありません。カーソルが現在セカンダリインデックスを使用していない場合、セカンダリインデックスブックマークに移動することは意味がありません。カーソルがセカンダリインデックスにない場合は、JetGotoBookmark を使用する必要があります。
JET_errNotInitialized	セッションに関連付けられているインスタンスがまだ初期化されていないため、操作を完了できません。
JET_errRecordDeleted	セカンダリインデックスブックマークに関連付けられているインデックスエントリが見つかりませんでした。
JET_errRestoreInProgress	セッションに関連付けられているインスタンスで復元操作が進行中のため、操作を完了できません。
JET_errSessionSharingViolation	同じセッションを複数のスレッドに同時に使用することはできません。 Windows XP: この戻り値は Windows XP で導入されています。
JET_errTermInProgress	セッションに関連付けられているインスタンスがシャットダウンされているため、操作を完了できません。

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

この関数が失敗した場合、JET_errRecordDeletedが返され、JET_bitBookmarkPermitVirtualCurrencyが指定されていない限り、カーソルの位置は変更されません。その場合、カーソルは、指定されたセカンダリインデックスブックマークに関連付けられているインデックスエントリが配置された場所に配置されます。カーソルは、その位置を基準にして移動できますが、有効なインデックスエントリ上にありません。

レコードが更新用に準備されている場合、その更新は取り消されます。インデックス範囲が有効な場合、そのインデックス範囲は取り消されます。カーソルで使用する検索キーが作成されている場合、その検索キーは削除されます。いずれの場合も、データベースの状態は変更されません。

要件

要件	値
Client	Windows Vista または Windows XP が必要です。
[サーバー]	Windows Server 2008 または Windows Server 2003 が必要です。
Header	Esent.h で宣言されています。
Library	ESENT.lib を使用します。
[DLL]	ESENT.dllが必要です。

参照

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetGetSecondaryIndexBookmark
JetGotoBookmark
JetStopService

次の方法で共有

JetGotoSecondaryIndexBookmark 関数

JetGotoSecondaryIndexBookmark 関数

パラメーター

戻り値

要件

参照

フィードバック

その他のリソース