JetGetTableIndexInfo-Funktion
Gilt für: Windows | Windows Server
JetGetTableIndexInfo-Funktion
Die JetGetTableIndexInfo-Funktion ruft Informationen zu einem Index ab.
JET_ERR JET_API JetGetTableIndexInfo(
__in JET_SESID sesid,
__in JET_TABLEID tableid,
__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.
tableid
Die Datenbanktabelle, die den Index enthält, der die erforderlichen Informationen enthält.
szIndexName
Der Name des Indexes, der informationen enthält, die abgerufen werden.
pvResult
Zeiger auf einen Puffer, der die Informationen erhält. Der Puffer sollte ausgerichtet werden, um den erforderlichen Typ zu halten. Der Typ des Puffers ist vom InfoLevel-Parameter abhängig.
cbResult
Die Größe des Puffers in Bytes, der im pvResult-Parameter übergeben wird.
InfoLevel
Gibt an, welche Informationen in pvResult gespeichert werden. Gültige Werte sind:
Wert |
Bedeutung |
|---|---|
JET_IdxInfo |
pvResult wird als eine JET_INDEXLIST interpretiert. Bei Erfolg empfängt JET_INDEXLIST Struktur Informationen zum Index. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoLCID |
pvResult wird als LCID interpretiert. Bei Erfolg enthält die LCID den Locale Identifier des Indexes. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoList |
pvResult wird als eine JET_INDEXLIST interpretiert. Bei Erfolg empfängt 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 die ULONG die Speicherplatznutzung des Indexes. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoSysTabCursor |
JET_IdxInfoSysTabCursor ist veraltet. |
JET_IdxInfoLangid |
JET_IdxInfoLangid ist veraltet. Verwenden JET_IdxInfoLCID stattdessen und stattdessen das Makro LANGIDFROMLCID. |
JET_IdxInfoCount |
pvResult wird als ULONG interpretiert. Bei Erfolg enthält die ULONG die Anzahl der Indizes für die angegebene Tabelle. szIndexName wird ignoriert. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoVarSegMac |
pvResult wird als USHORT interpretiert. Bei Erfolg enthält USHORT den Wert von cbVarSegMac, der beim Erstellen des Indexes verwendet wurde. Eine Beschreibung JET_INDEXCREATE cbVarSegMacfinden Sie unter . Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoIndexId |
pvResult wird als JET_INDEXID. Bei Erfolg empfängt JET_INDEXID-Struktur Informationen zum Index. 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 cbKeyMost finden Sie in der JET_INDEXCREATE-Struktur. Bei einem Fehler ist der Inhalt von pvBuffer nicht definiert. |
JET_IdxInfoCreateIndex |
pvResult wird als JET_INDEXCREATE 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 eine JET_INDEXCREATE2 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 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 in der Angabe der Tabelle. 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 |
Wird in Esent.h deklariert. |
Bibliothek |
Verwenden Sie ESENT.lib. |
DLL |
Erfordert ESENT.dll. |
Unicode |
Wird als JetGetTableIndexInfoW (Unicode) und JetGetTableIndexInfoA (ANSI) implementiert. |
Weitere Informationen
JET_COLUMNID
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JET_INDEXID
JetGetIndexInfo