JetGetTableIndexInfo-Funktion
Letzte Änderung: Freitag, 27. Februar 2015
Gilt für: Windows | Windows Server
JetGetTableIndexInfo-Funktion
Die Funktion JetGetTableIndexInfo Informationen über einen Index abgerufen.
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 Kontext, für den API-Aufruf zu verwendenden Datenbank Sitzung.
TableID
Die Datenbanktabelle, die den Index enthält, der die benötigte Informationen enthält.
szIndexName
Der Name des Indexes, der Informationen enthält, die abgerufen werden sollen.
pvResult
Zeiger auf einen Puffer, der Informationen zu erhalten. Puffer sollte angepasst werden, um den erforderlichen Typ halten. Der Typ des Puffers ist abhängig von der InfoLevel -Parameter.
cbResult
Die Größe des Puffers in Bytes, die im PvResult -Parameter übergeben werden.
InfoLevel
Gibt an, welche Informationen in PvResultgespeichert werden sollen. Gültige Werte sind:
Wert |
Bedeutung |
|---|---|
JET_IdxInfo |
PvResult wird als eine Struktur JET_INDEXLIST interpretiert. Die Struktur JET_INDEXLIST empfängt Erfolg Informationen über den Index. Bei einem Fehler werden der Inhalt der PvBuffer nicht definiert. |
JET_IdxInfoLCID |
PvResult wird als LCID interpretiert. Klicken Sie auf Erfolg enthält die LCID die Gebietsschema-ID des Indexes. Bei einem Fehler werden der Inhalt der PvBuffer nicht definiert. |
JET_IdxInfoList |
PvResult wird als eine Struktur JET_INDEXLIST interpretiert. Die Struktur JET_INDEXLIST empfängt Erfolg Informationen über den Index. Bei einem Fehler werden der Inhalt der 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 der Speichernutzung des Indexes. Bei einem Fehler werden der Inhalt der PvBuffer nicht definiert. |
JET_IdxInfoSysTabCursor |
JET_IdxInfoSysTabCursor ist veraltet. |
JET_IdxInfoLangid |
JET_IdxInfoLangid ist veraltet. Verwenden Sie stattdessen JET_IdxInfoLCID und das Makro LANGIDFROMLCID stattdessen. |
JET_IdxInfoCount |
PvResult wird als ULONG interpretiert. Bei Erfolg enthält die ULONG die Anzahl der Indizes für die angegebene Tabelle an. SzIndexName wird ignoriert. Bei einem Fehler werden der Inhalt der PvBuffer nicht definiert. |
JET_IdxInfoVarSegMac |
PvResult wird als USHORT interpretiert. Klicken Sie auf Erfolg enthält die USHORT den Wert des CbVarSegMac verwendet, wenn der Index erstellt wurde. Eine Beschreibung der CbVarSegMacfinden Sie unter JET_INDEXCREATE . Bei einem Fehler werden der Inhalt der PvBuffer nicht definiert. |
JET_IdxInfoIndexId |
PvResult wird als eine JET_INDEXIDinterpretiert. Die Struktur JET_INDEXID empfängt Erfolg Informationen über den Index. Bei einem Fehler werden der Inhalt der PvBuffer nicht definiert. |
JET_IdxInfoKeyMost |
PvResult wird als USHORT interpretiert. Klicken Sie auf Erfolg enthält die USHORT den Wert des CbKeyMost verwendet, wenn der Index erstellt wurde. Finden Sie unter der Struktur JET_INDEXCREATE eine Beschreibung der CbKeyMost. Bei einem Fehler werden der Inhalt der PvBuffer nicht definiert. |
JET_IdxInfoCreateIndex |
PvResult wird als eine Struktur JET_INDEXCREATE interpretiert. Bei einem Fehler werden der Inhalt der PvBuffer nicht definiert. Windows 7:JET_IdxInfoCreateIndex ist in Windows 7 eingeführt. |
JET_IdxInfoCreateIndex2 |
PvResult wird als eine Struktur JET_INDEXCREATE2 interpretiert. Bei einem Fehler werden der Inhalt der PvBuffer nicht definiert. Windows 7:JET_IdxInfoCreateIndex2 ist in Windows 7 eingeführt. |
Return Value
Diese Funktion gibt den Datentyp JET_ERR mit einem der folgenden Rückgabecodes. Weitere Informationen zu den möglichen ESE-Fehlern finden Sie unter Extensible Storage Engine-Fehlern und Fehler behandeln von Parametern.
Rückgabecode |
Beschreibung |
|---|---|
JET_errSuccess |
Der Vorgang wurde erfolgreich abgeschlossen. |
JET_errIndexNotFound |
Im angegebene Index kann nicht in der angegebenen Tabelle gefunden werden. |
JET_wrnBufferTruncated |
Als PvResult übergebene Puffer war zu klein. Der Inhalt des Puffers ist nicht definiert. |
Anmerkungen
Abrufen von JetGetIndexInfo und JetGetTableIndexInfo identische Informationen über einen Index. Der Unterschied liegt in die Tabelle wie angegeben ist. JetGetIndexInfo erwartet, dass eine Datenbank (Dbid) und den Namen einer Tabelle (SzTableName) zwar JetGetTableIndexInfo eine Tabelle-ID (Tableid) erwartet.
Voraussetzungen
-Client, |
Erfordert Windows Vista, Windows XP oder Windows 2000 Professional. |
Server |
WindowsServer 2008, WindowsServer 2003 oder Windows 2000 Server benötigt. |
Kopfzeile |
In Esent.h deklariert. |
Library |
Verwenden Sie ESENT.lib. |
DLL |
Erfordert "ESENT.dll". |
Unicode |
Implementiert als JetGetTableIndexInfoW (Unicode) und JetGetTableIndexInfoA (ANSI). |
Siehe auch
JET_COLUMNID
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JET_INDEXID
JetGetIndexInfo