Fonction JetCreateIndex

S’applique à : Windows | Windows Server

Fonction JetCreateIndex

La fonction JetCreateIndex vous permet de créer un index de données dans une base de données ESE (Extensible Storage Engine), que vous pouvez utiliser pour localiser rapidement des données spécifiques.

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

Paramètres

sesid

Contexte de session de base de données à utiliser pour un appel d’API particulier.

tableid

Table pour laquelle un index sera créé.

szIndexName

Pointeur vers une chaîne terminée par null qui spécifie le nom de l’index à créer.

Le nom de l’index doit être conforme aux instructions suivantes :

• Il doit contenir moins de caractères que JET_cbNameMost, sans compter le caractère null de fin.

• Il doit contenir uniquement des caractères des catégories suivantes : 0 à 9, A à Z, a à z, et tous les caractères de ponctuation à l’exception de « ! » (point d’exclamation), « , » (virgule), « [ » (crochet ouvrant) et « ] » (crochet fermant), c’est-à-dire les caractères ASCII 0x20, 0x22 via 0x2d, 0x2f via 0x5a, 0x5c et 0x5d via 0x7f.

• Il ne doit pas commencer par un espace.

• Il doit contenir au moins un caractère autre que l’espace.

grbit

Groupe de bits qui contient les options à utiliser pour un appel particulier. Ce paramètre peut inclure zéro ou plusieurs options trouvées dans la structure JET_INDEXCREATE .

szKey

Pointeur vers une chaîne null double de jetons délimités par null.

Pour plus d’informations sur ce paramètre, consultez la structure JET_INDEXCREATE .

cbKey

Longueur, en octets, du paramètre szKey , y compris les deux caractères null de fin.

lDensity

Densité en pourcentage de l’arborescence d’index B+ initiale.

Pour plus d’informations sur ce paramètre, consultez la structure JET_INDEXCREATE .

Valeur renvoyée

Cette fonction retourne le type de données JET_ERR avec l’un des codes de retour répertoriés dans le tableau suivant. Pour plus d’informations sur les erreurs ESE possibles, consultez Erreurs du moteur de stockage extensible et Paramètres de gestion des erreurs.

Code de retour	Signification
JET_errSuccess	L’opération s’est terminée avec succès.

Pour obtenir la liste des erreurs supplémentaires qui peuvent être retournées par la fonction JetCreateIndex , consultez JetCreateIndex2.

Notes

L’appel de la fonction JetCreateIndex est identique à l’appel de la fonction JetCreateIndex2 avec une structure de JET_INDEXCREATE contenant les mêmes paramètres que les paramètres de JetCreateIndex et un paramètre cIndexCreate égal à 1. Pour les champs de la structure JET_INDEXCREATE qui n’ont pas de paramètres correspondants dans JetCreateIndex, la valeur 0 est supposée.

Notez que JetCreateIndex a été remplacé par JetCreateIndex2.

Spécifications

Condition requise	Valeur
Client	Nécessite Windows Vista, Windows XP ou Windows 2000 Professionnel.
Serveur	Nécessite Windows Server 2008, Windows Server 2003 ou Windows 2000 Server.
En-tête	Est déclaré dans Esent.h.
Bibliothèque	Utilise ESENT.lib.
DLL	Nécessite ESENT.dll.
Unicode	Est implémenté en tant que JetCreateIndexW (Unicode) et JetCreateIndexA (ANSI).

Voir aussi

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JetCreateIndex2
JetCreateTableColumnIndex
JetCreateTableColumnIndex2