Función JetCreateIndex

Se aplica a: Windows | Windows Server

Función JetCreateIndex

La función JetCreateIndex permite crear un índice de datos en una base de datos del motor de almacenamiento extensible (ESE), que puede usar para buscar datos específicos rápidamente.

    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
    );

Parámetros

sesid

Contexto de sesión de base de datos que se va a usar para una llamada API determinada.

tableid

Tabla para la que se creará un índice.

szIndexName

Puntero a una cadena terminada en null que especifica el nombre del índice que se va a crear.

El nombre del índice debe cumplir las siguientes directrices:

• Debe contener menos caracteres que JET_cbNameMost, sin incluir el carácter nulo de terminación.

• Solo debe contener caracteres de las siguientes categorías: 0 a 9, A a Z, a a z y todos los caracteres de puntuación excepto "!" (signo de exclamación), "," (coma), "[" (corchete de apertura) y "]" (corchete de cierre), es decir, los caracteres ASCII 0x20, 0x22 a través de 0x2d, 0x2f a través de 0x5a, 0x5c y 0x5d a través de 0x7f.

• No debe comenzar con un espacio.

• Debe contener al menos un carácter que no sea de espacio.

grbit

Un grupo de bits que contiene las opciones que se usarán para una llamada determinada. Este parámetro puede incluir cero o más de las opciones que se encuentran en la estructura JET_INDEXCREATE .

szKey

Puntero a una cadena terminada en null doble de tokens delimitados por null.

Para obtener más información sobre este parámetro, consulte la estructura JET_INDEXCREATE .

cbKey

Longitud, en bytes, del parámetro szKey , incluidos los dos caracteres NULOs de terminación.

lDensity

Densidad porcentual del árbol B+ de índice inicial.

Para obtener más información sobre este parámetro, consulte la estructura JET_INDEXCREATE .

Valor devuelto

Esta función devuelve el tipo de datos JET_ERR con uno de los códigos de retorno enumerados en la tabla siguiente. Para obtener más información sobre los posibles errores de ESE, vea Extensible Storage Engine Errors and Error Handling Parameters.

Código de retorno	Significado
JET_errSuccess	La operación se ha completado correctamente.

Para obtener una lista de errores adicionales que puede devolver la función JetCreateIndex , consulte JetCreateIndex2.

Comentarios

Llamar a la función JetCreateIndex es idéntica a llamar a la función JetCreateIndex2 con una estructura de JET_INDEXCREATE que contiene la misma configuración que los parámetros de JetCreateIndex y un parámetro cIndexCreate igual a 1. Para los campos de la estructura JET_INDEXCREATE que no tienen parámetros correspondientes en JetCreateIndex, se supone un valor de 0.

Tenga en cuenta que JetCreateIndex se ha reemplazado por JetCreateIndex2.

Requisitos

Requisito	Value
Remoto	Requiere Windows Vista, Windows XP o Windows 2000 Professional.
Servidor	Requiere Windows Server 2008, Windows Server 2003 o Windows 2000 Server.
Encabezado	Se declara en Esent.h.
Biblioteca	Usa ESENT.lib.
Archivo DLL	Requiere ESENT.dll.
Unicode	Se implementa como JetCreateIndexW (Unicode) y JetCreateIndexA (ANSI).

Consulte también

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JetCreateIndex2
JetCreateTableColumnIndex
JetCreateTableColumnIndex2