Функция JetCreateIndex

Статья
06/13/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.

Дополнительные сведения об этом параметре см. в разделе структура JET_INDEXCREATE .

cbKey

Длина (в байтах) параметра szKey , включая два завершающих символа NULL.

lDensity

Процентная плотность исходного дерева индекса B+.

Дополнительные сведения об этом параметре см. в разделе структура JET_INDEXCREATE .

Возвращаемое значение

Эта функция возвращает JET_ERR тип данных с одним из кодов возврата, перечисленных в следующей таблице. Дополнительные сведения о возможных ошибках ESE см. в разделах Ошибки подсистемы расширяемого хранилища и Параметры обработки ошибок.

Код возврата	Значение
JET_errSuccess	Операция выполнена успешно.

Список дополнительных ошибок, которые могут быть возвращены функцией JetCreateIndex , см. в разделе JetCreateIndex2.

Вызов функции JetCreateIndex идентичен вызову функции JetCreateIndex2 с JET_INDEXCREATE структурой, содержащей те же параметры, что и параметры JetCreateIndex, и параметр cIndexCreate , равный 1. Для полей структуры JET_INDEXCREATE , не имеющих соответствующих параметров в JetCreateIndex, предполагается значение 0.

Обратите внимание, что JetCreateIndex был заменен JetCreateIndex2.

Требования

Требование	Значение
клиент	Требуется Windows Vista, Windows XP или Windows 2000 Professional.
Сервер	Требуется Windows Server 2008, Windows Server 2003 или Windows 2000 Server.
Заголовок	Объявляется в Esent.h.
Библиотека	Использует ESENT.lib.
DLL	Требуется ESENT.dll.
Юникод	Реализуется как JetCreateIndexW (Юникод) и JetCreateIndexA (ANSI).

См. также:

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JetCreateIndex2
JetCreateTableColumnIndex
JetCreateTableColumnIndex2

Share via

Функция JetCreateIndex