JetCreateIndex 函式

發行項
06/12/2023

適用于： Windows |Windows Server

JetCreateIndex 函式

JetCreateIndex函式可讓您在可延伸儲存引擎中建立資料索引， (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 結束之字串的指標，指定要建立之索引的名稱。

索引名稱必須符合下列指導方針：

它必須包含少於JET_cbNameMost的字元，不包括終止的 Null 字元。
它只能包含下列類別的字元：0 到 9、A 到 Z、a 到 z，以及除了「！」 (驚嘆號以外的所有標點符號字元) ，「，」 (逗號) 、「[」 (左括弧) 和「]」 (右括弧) ，也就是 ASCII 字元0x20、0x22 0x2d、0x2f到0x5a、0x5c和0x5d 0x7f。
它不得以空格開頭。
它至少必須包含一個非空白字元。

grbit

一組位，其中包含要用於特定呼叫的選項。此參數可以包含 JET_INDEXCREATE 結構中找到的零或多個選項。

szKey

以 Null 分隔之標記之雙 Null 終止字串的指標。

如需此參數的詳細資訊，請參閱 JET_INDEXCREATE 結構。

cbKey

szKey參數的長度，以位元組為單位，包括兩個終止的 Null 字元。

lDensity

初始索引 B+ 樹狀結構的百分比密度。

如需此參數的詳細資訊，請參閱 JET_INDEXCREATE 結構。

傳回值

此函式會傳回具有下表所列其中一個傳回碼的JET_ERR 資料類型。如需可能 ESE 錯誤的詳細資訊，請參閱可延伸儲存引擎錯誤和錯誤處理參數。

傳回碼	意義
JET_errSuccess	作業已成功完成。

如需 JetCreateIndex 函式可傳回的其他錯誤清單，請參閱 JetCreateIndex2。

備註

呼叫 JetCreateIndex 函式與呼叫 JetCreateIndex2 函式的方式相同， JET_INDEXCREATE 其結構包含與 JetCreateIndex參數相同的設定， 而 cIndexCreate 參數等於 1。對於JetCreateIndex中沒有對應參數之JET_INDEXCREATE結構的欄位，會假設值為 0。

請注意 ，JetCreateIndex 已被 JetCreateIndex2取代。

規格需求

需求	值
Client	需要 Windows Vista、Windows XP 或 Windows 2000 Professional。
伺服器	需要 Windows Server 2008、Windows Server 2003 或 Windows 2000 Server。
標頭	在 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

共用方式為

JetCreateIndex 函式