次の方法で共有

JetCreateIndex 関数

  • [アーティクル]

適用対象: Windows |Windows Server

JetCreateIndex 関数

JetCreateIndex 関数を使用すると、Extensible Storage Engine (ESE) データベースにデータのインデックスを作成できます。これを使用すると、特定のデータをすばやく見つけることができます。

    JET_ERR JET_API JetCreateIndex(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          JET_PCSTR szIndexName,
      __in          JET_GRBIT grbit,
      __in          const tchar* szKey,
      __in          unsigned long cbKey,
      __in          unsigned long lDensity
    );

パラメーター

sesid

特定の API 呼び出しに使用するデータベース セッション コンテキスト。

tableid

インデックスが作成されるテーブル。

szIndexName

作成するインデックスの名前を指定する null で終わる文字列へのポインター。

インデックス名は、次のガイドラインに従う必要があります。

  • 終端の null 文字を含めずに、JET_cbNameMostよりも少ない文字を含める必要があります。

  • 0 ~ 9、A ~ Z、a ~ z、および "!" を除くすべての句読点の各カテゴリの文字のみを含める必要があります。(感嘆符)、"、" (コンマ)、"[" (左角かっこ)、および "]" (右角かっこ) — つまり、ASCII 文字0x20、0x2d 0x22、0x5a、0x5c、0x5dから0x7fを0x2f。

  • スペースで始めてはいけません。

  • 少なくとも 1 つの空白以外の文字を含む必要があります。

grbit

特定の呼び出しに使用するオプションを含むビットのグループ。 このパラメーターには、 JET_INDEXCREATE 構造体に含まれる 0 個以上のオプションを含めることができます。

szKey

null で区切られたトークンの二重 null で終わる文字列へのポインター。

このパラメーターの詳細については、 JET_INDEXCREATE 構造体に関するページを参照してください。

cbKey

2 つの終端 null 文字を含む 、szKey パラメーターの長さ (バイト単位)。

lDensity

初期インデックス B+ ツリーのパーセンテージ密度。

このパラメーターの詳細については、 JET_INDEXCREATE 構造体に関するページを参照してください。

戻り値

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

リターン コード

意味

JET_errSuccess

操作は正常に完了しました。

JetCreateIndex 関数によって返されるその他のエラーの一覧については、「JetCreateIndex2」を参照してください。

注釈

JetCreateIndex 関数の呼び出しは、JetCreateIndex のパラメーターと同じ設定を含むJET_INDEXCREATE構造体を使用して JetCreateIndex2 関数を呼び出すことと同じです。cIndexCreate パラメーターは 1 です。 JetCreateIndex に対応するパラメーターがないJET_INDEXCREATE構造体のフィールドでは、値 0 が想定されます。

JetCreateIndex は JetCreateIndex2 に置き換えられていることに注意してください。

要件

要件 値

クライアント

Windows Vista、Windows XP、または Windows 2000 Professional が必要です。

サーバー

Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。

Header

Esent.h で宣言されています。

ライブラリ

ESENT.lib を使用します。

[DLL]

ESENT.dllが必要です。

Unicode

JetCreateIndexW (Unicode) および JetCreateIndexA (ANSI) として実装されます。

参照

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JetCreateIndex2
JetCreateTableColumnIndex
JetCreateTableColumnIndex2