Fonction JetGetIndexInfo

Article
06/13/2023

S’applique à : Windows | Windows Server

Fonction JetGetIndexInfo

La fonction JetGetIndexInfo récupère des informations sur un index.

    JET_ERR JET_API JetGetIndexInfo(
      __in          JET_SESID sesid,
      __in          JET_DBID dbid,
      __in          const tchar* szTableName,
      __in          const tchar* szIndexName,
      __out         void* pvResult,
      __in          unsigned long cbResult,
      __in          unsigned long InfoLevel
    );

Paramètres

sesid

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

dbid

Identificateur de base de données à utiliser pour l’appel d’API.

szTableName

Nom de la table contenant l’index avec les informations à récupérer.

szIndexName

Nom de l’index avec les informations à récupérer.

pvResult

Pointeur vers une mémoire tampon qui recevra les informations souhaitées. La mémoire tampon doit être alignée pour contenir le type requis. Le type de la mémoire tampon dépend du paramètre InfoLevel .

cbResult

Taille, en octets, de la mémoire tampon passée en tant que pvResult.

InfoLevel

Informations qui seront stockées dans pvResult. Les options suivantes peuvent être utilisées pour ce paramètre.

Valeur	Signification
JET_IdxInfo	pvResult est interprété comme une structure JET_INDEXLIST . En cas de réussite, la structure JET_INDEXLIST reçoit des informations sur l’index. En cas d’échec, le contenu de pvBuffer n’est pas défini.
JET_IdxInfoCount	pvResult est interprété comme un ULONG. En cas de réussite, l’ULONG conserve le nombre d’index sur la table spécifiée. szIndexName est ignoré. En cas d’échec, le contenu de pvBuffer n’est pas défini.
JET_IdxInfoIndexId	pvResult est interprété comme un JET_INDEXID. En cas de réussite, la structure JET_INDEXID reçoit des informations sur l’index. En cas d’échec, le contenu de pvBuffer n’est pas défini.
JET_IdxInfoLangid	JET_IdxInfoLangid est déconseillé. Utilisez JET_IdxInfoLCID et la macro LANGIDFROMLCID à la place.
JET_IdxInfoLCID	pvResult est interprété comme un LCID. En cas de réussite, le LCID contient l’identificateur de paramètres régionaux de l’index. En cas d’échec, le contenu de pvBuffer n’est pas défini. Windows XP : JET_IdxInfoLCID est introduit dans Windows XP.
JET_IdxInfoList	pvResult est interprété comme une structure JET_INDEXLIST . En cas de réussite, la structure JET_INDEXLIST reçoit des informations sur l’index. En cas d’échec, le contenu de pvBuffer n’est pas défini.
JET_IdxInfoOLC	JET_IdxInfoOLC est obsolète.
JET_IdxInfoResetOLC	JET_IdxInfoResetOLC est obsolète.
JET_IdxInfoSpaceAlloc	pvResult est interprété comme un ULONG. En cas de réussite, l’ULONG conserve l’utilisation de l’espace de l’index. En cas d’échec, le contenu de pvBuffer n’est pas défini.
JET_IdxInfoSysTabCursor	JET_IdxInfoSysTabCursor est obsolète.
JET_IdxInfoVarSegMac	pvResult est interprété comme un USHORT. En cas de réussite, l’USHORT conserve la valeur cbVarSegMac utilisée lors de la création de l’index. Consultez JET_INDEXCREATE pour obtenir une description de cbVarSegMac. En cas d’échec, le contenu de pvBuffer n’est pas défini.
JET_IdxInfoKeyMost	pvResult est interprété comme un USHORT. En cas de réussite, L’USHORT contient la valeur cbKeyMost utilisée lors de la création de l’index. Consultez JET_INDEXCREATE pour obtenir une description de cbKeyMost. En cas d’échec, le contenu de pvBuffer n’est pas défini. Windows Vista : JET_IdxInfoKeyMost est introduit dans Windows Vista.
JET_IdxInfoCreateIndex	pvResult est interprété comme une structure JET_INDEXCREATE . En cas d’échec, le contenu de pvBuffer n’est pas défini. Windows 7 : JET_IdxInfoCreateIndex est introduit dans Windows 7.
JET_IdxInfoCreateIndex2	pvResult est interprété comme une structure JET_INDEXCREATE2 . En cas d’échec, le contenu de pvBuffer n’est pas défini. Windows 7 : JET_IdxInfoCreateIndex2 est introduit dans Windows 7.

Valeur renvoyée

Cette fonction retourne le type de données JET_ERR avec l’un des codes de retour suivants. 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	Description
JET_errSuccess	L’opération s’est terminée avec succès.
JET_errIndexNotFound	L’index spécifié est introuvable dans la table spécifiée.
JET_wrnBufferTruncated	La mémoire tampon passée en tant que pvResult était trop petite. Le contenu de la mémoire tampon n’est pas défini.

Notes

JetGetIndexInfo et JetGetTableIndexInfo récupèrent des informations identiques sur un index. La différence réside dans la façon dont la table est spécifiée. JetGetIndexInfo attend une base de données (dbid) et le nom d’une table (szTableName), tandis que JetGetTableIndexInfo attend un identificateur de table (tableid).

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	Déclaré dans Esent.h.
Bibliothèque	Utilisez ESENT.lib.
DLL	Nécessite ESENT.dll.
Unicode	Implémenté en tant que JetGetIndexInfoW (Unicode) et JetGetIndexInfoA (ANSI).

Voir aussi

JET_COLUMNID
JET_ERR
JET_GRBIT
JET_INDEXCREATE
JET_INDEXID
JET_SESID
JET_TABLEID
JetGetTableIndexInfo

Partager via

Fonction JetGetIndexInfo