JetGetIndexInfo-Funktion

Gilt für: Windows | Windows Server-

JetGetIndexInfo-Funktion

Die JetGetIndexInfo-Funktion ruft Informationen zu einem Index ab.

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

Parameter

sesid

Der Datenbanksitzungskontext, der für den API-Aufruf verwendet werden soll.

dbid

Der Datenbankbezeichner, der für den API-Aufruf verwendet werden soll.

szTableName

Der Name der Tabelle, die den Index mit den abzurufenden Informationen enthält.

szIndexName

Der Name des Indexes mit den abzurufenden Informationen.

pvResult

Zeigen Sie auf einen Puffer, der die gewünschten Informationen empfängt. Der Puffer sollte für den erforderlichen Typ ausgerichtet werden. Der Typ des Puffers ist vom InfoLevel-Parameter abhängig.

cbResult

Die Größe des Puffers in Bytes, der als pvResult übergeben wird.

InfoLevel

Die Informationen, die in pvResult gespeichert werden. Die folgenden Optionen können für diesen Parameter verwendet werden.

Wert Bedeutung

JET_IdxInfo

pvResult wird als JET_INDEXLIST Struktur interpretiert. Bei Erfolg erhält die JET_INDEXLIST-Struktur Informationen zum Index. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

JET_IdxInfoCount

pvResult wird als ULONG interpretiert. Bei Erfolg enthält die ULONG die Anzahl der Indizes in der angegebenen Tabelle. szIndexName wird ignoriert. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

JET_IdxInfoIndexId

pvResult wird als JET_INDEXID interpretiert. Bei Erfolg erhält die JET_INDEXID Struktur Informationen zum Index. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

JET_IdxInfoLangid

JET_IdxInfoLangid ist veraltet. Verwenden Sie stattdessen JET_IdxInfoLCID und das LANGIDFROMLCID-Makro .

JET_IdxInfoLCID

pvResult wird als LCID interpretiert. Bei Erfolg enthält die LCID den Gebietsschemabezeichner des Indexes. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

Windows XP: JET_IdxInfoLCID wird in Windows XP eingeführt.

JET_IdxInfoList

pvResult wird als JET_INDEXLIST Struktur interpretiert. Bei Erfolg erhält die JET_INDEXLIST-Struktur Informationen zum Index. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

JET_IdxInfoOLC

JET_IdxInfoOLC ist veraltet.

JET_IdxInfoResetOLC

JET_IdxInfoResetOLC ist veraltet.

JET_IdxInfoSpaceAlloc

pvResult wird als ULONG interpretiert. Bei Erfolg enthält die ULONG die Zieldichte (ulDensity) des Indexes. Eine Beschreibung der UlDensity finden Sie unter JET_INDEXCREATE. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

JET_IdxInfoSysTabCursor

JET_IdxInfoSysTabCursor ist veraltet.

JET_IdxInfoVarSegMac

pvResult wird als USHORT interpretiert. Bei Erfolg enthält die USHORT den Wert von cbVarSegMac , der beim Erstellen des Indexes verwendet wurde. Eine Beschreibung von cbVarSegMac finden Sie unter JET_INDEXCREATE. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

JET_IdxInfoKeyMost

pvResult wird als USHORT interpretiert. Bei Erfolg enthält die USHORT den Wert von cbKeyMost , der beim Erstellen des Indexes verwendet wurde. Eine Beschreibung von cbKeyMost finden Sie unter JET_INDEXCREATE. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

Windows Vista: JET_IdxInfoKeyMost wird in Windows Vista eingeführt.

JET_IdxInfoCreateIndex

pvResult wird als JET_INDEXCREATE Struktur interpretiert. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

Windows 7: JET_IdxInfoCreateIndex wird in Windows 7 eingeführt.

JET_IdxInfoCreateIndex2

pvResult wird als JET_INDEXCREATE2 Struktur interpretiert. Bei Ausfall sind die Inhalte von pvBuffer nicht definiert.

Windows 7: JET_IdxInfoCreateIndex2 wird in Windows 7 eingeführt.
JET_IdxInfoSpaceOwned pvResult wird als ein ULONG. Bei Erfolg enthält die ULONG Anzahl der Seiten, die im Besitz des Index sind. Weitere Informationen finden Sie unter Hinweise.

Windows 11:JET_IdxInfoSpaceOwned wird in Windows 11 eingeführt.
JET_IdxInfoSpaceAvail pvResult wird als ein ULONG. Bei Erfolg enthält die ULONG Anzahl der im Index verfügbaren Seiten. Weitere Informationen finden Sie unter Hinweise.

Windows 11:JET_IdxInfoSpaceAvail wird in Windows 11 eingeführt.

Rückgabewert

Diese Funktion gibt den Datentyp JET_ERR mit einem der folgenden Rückgabecodes zurück. Weitere Informationen zu möglichen ESE-Fehlern finden Sie unter Extensible Storage Engine Errors and Error Handling Parameters.

Rückgabecode

Description

JET_errSuccess

Der Vorgang wurde erfolgreich abgeschlossen.

JET_errIndexNotFound

Der angegebene Index wurde in der angegebenen Tabelle nicht gefunden.

JET_wrnBufferTruncated

Der als pvResult übergebene Puffer war zu klein. Der Inhalt des Puffers ist nicht definiert.

Hinweise

JetGetIndexInfo und JetGetTableIndexInfo rufen identische Informationen zu einem Index ab. Der Unterschied besteht darin, wie die Tabelle angegeben wird. JetGetIndexInfo erwartet eine Datenbank (dbid) und den Namen einer Tabelle (szTableName), während JetGetTableIndexInfo einen Tabellenbezeichner (Tableid) erwartet.

Der von einem Index verbrauchte Speicherplatz wird durch $Used + Avail = Owned$definiert. Verwenden Sie daher die Formel $Owned - Avail = Used$ (abrufbar mit JET_IdxInfoSpaceOwned und JET_IdxInfoSpaceAvail).

Anforderungen

Anforderung Wert

Client

Erfordert Windows Vista, Windows XP oder Windows 2000 Professional.

Server

Erfordert Windows Server 2008, Windows Server 2003 oder Windows 2000 Server.

Header

Deklariert in Esent.h.

Bibliothek

Verwenden Sie ESENT.lib.

DLL

Erfordert ESENT.dll.

Unicode

Implementiert als JetGetIndexInfoW (Unicode) und JetGetIndexInfoA (ANSI).

Siehe auch

JET_COLUMNID JET_ERR JET_GRBITJET_INDEXCREATEJET_INDEXCREATE2 JET_INDEXIDJET_INDEXLIST JET_SESID JET_TABLEID JetGetTableIndexInfo

  • Last updated on