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 abzurufende Informationen.
pvResult
Zeiger auf einen Puffer, der die gewünschten Informationen empfängt. Der Puffer sollte so ausgerichtet sein, dass er den erforderlichen Typ aufnehmen kann. 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. Für diesen Parameter können die folgenden Optionen verwendet werden.
Wert |
Bedeutung |
|---|---|
JET_IdxInfo |
pvResult wird als JET_INDEXLIST-Struktur interpretiert. Bei Erfolg empfängt die JET_INDEXLIST-Struktur Informationen zum Index. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoCount |
pvResult wird als ULONG interpretiert. Bei Erfolg enthält ULONG die Anzahl der Indizes für die angegebene Tabelle. szIndexName wird ignoriert. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoIndexId |
pvResult wird als JET_INDEXIDinterpretiert. Bei Erfolg empfängt die JET_INDEXID-Struktur Informationen über den Index. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoLangid |
JET_IdxInfoLangid ist veraltet. Verwenden Sie stattdessen JET_IdxInfoLCID und das MAKRO LANGIDFROMLCID. |
JET_IdxInfoLCID |
pvResult wird als LCID interpretiert. Bei Erfolg enthält die LCID den Gebietsschemabezeichner des Indexes. Bei einem Fehler ist der Inhalt 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 empfängt die JET_INDEXLIST-Struktur Informationen zum Index. Bei einem Fehler ist der Inhalt 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 ULONG die Speicherplatznutzung des Indexes. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoSysTabCursor |
JET_IdxInfoSysTabCursor ist veraltet. |
JET_IdxInfoVarSegMac |
pvResult wird als USHORT interpretiert. Bei Erfolg enthält USHORT den Wert cbVarSegMac, der beim Erstellen des Indexes verwendet wurde. Eine Beschreibung von cbVarSegMacfinden Sie unter JET_INDEXCREATE. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoKeyMost |
pvResult wird als USHORT interpretiert. Bei Erfolg enthält USHORT den Wert cbKeyMost, der beim Erstellen des Indexes verwendet wurde. Eine Beschreibung von cbKeyMostfinden Sie unter JET_INDEXCREATE. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. Windows Vista: JET_IdxInfoKeyMost wird in Windows Vista eingeführt. |
JET_IdxInfoCreateIndex |
pvResult wird als JET_INDEXCREATE-Struktur interpretiert. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. Windows 7: JET_IdxInfoCreateIndex wird in Windows 7 eingeführt. |
JET_IdxInfoCreateIndex2 |
pvResult wird als JET_INDEXCREATE2-Struktur interpretiert. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. Windows 7: JET_IdxInfoCreateIndex2 wird in Windows 7 eingeführt. |
Rückgabewert
Diese Funktion gibt den JET_ERR Datentyp mit einem der folgenden Rückgabecodes zurück. Weitere Informationen zu den möglichen ESE-Fehlern finden Sie unter Extensible Storage Engine Errors and Error Handling Parameters.
Rückgabecode |
Beschreibung |
|---|---|
JET_errSuccess |
Der Vorgang wurde erfolgreich abgeschlossen. |
JET_errIndexNotFound |
Der angegebene Index kann in der angegebenen Tabelle nicht gefunden werden. |
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.
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). |
Weitere Informationen
JET_COLUMNID
JET_ERR
JET_GRBIT
JET_INDEXCREATE
JET_INDEXID
JET_SESID
JET_TABLEID
JetGetTableIndexInfo