JetGetColumnInfo-Funktion
Letzte Änderung: Freitag, 27. Februar 2015
Gilt für: Windows | Windows Server
JetGetColumnInfo-Funktion
Die JetGetColumnInfo -Funktion ruft Informationen über eine Spalte ab.
JET_ERR JET_API JetGetColumnInfo(
__in JET_SESID sesid,
__in JET_DBID dbid,
__in const tchar* szTableName,
__in const tchar* szColumnName,
__out void* pvResult,
__in unsigned long cbMax,
__in unsigned long InfoLevel
);
Parameter
sesid
Die Sitzung Datenbankkontext für den API-Aufruf.
DBID
Identifiziert zusammen mit SzTableName, die Tabelle, die mit der Spalte, aus der die Informationen abgerufen werden.
szTableName
Identifiziert zusammen mit Dbid, die Tabelle, die mit der Spalte, aus der die Informationen abgerufen werden.
szColumnName
Der Name der Spalte, der für die Informationen abgerufen werden.
pvResult
Zeiger auf einen Puffer, der die Informationen angezeigt werden. Der Typ des Puffers ist abhängig von InfoLevel. Der Aufrufer muss konfiguriert werden, um den Puffer entsprechend auszurichten.
cbMax
Die Größe in Bytes des Puffers, der in PvResultübergeben wird.
InfoLevel
Der Typ der Informationen, die für die Spalte abrufen, die durch SzColumnNameangegeben ist. Dieser Parameter hängt das Format der Daten, die in PvResult gespeichert. Das Schema der temporären Tabelle finden Sie unter JET_COLUMNLIST.
Diese InfoLevels werden nach unterschieden:
JET_ColInfoListSortColumnid wird durch die Spalten-IDdie temporäre Tabelle sortieren.
JET_ColInfoListCompact wird die Ausgabe komprimieren. Weitere Informationen über die compact Ausgabe finden Sie unter JET_COLUMNLIST.
Die folgenden Optionen stehen für die Verwendung mit diesem Parameter.
Wert |
Bedeutung |
---|---|
JET_ColInfo |
JET_ColInfo und JET_ColInfoByColid abrufen die gleiche Informationen. PvResult wird als eine JET_COLUMNDEFinterpretiert, und die JET_COLUMNDEF die Felder ordnungsgemäß ausgefüllt. |
JET_ColInfoBase |
PvResult wird als eine JET_COLUMNBASE -Struktur interpretiert. Dies ist eine JET_COLUMNDEF -Struktur ähnelt. Wenn diese Funktion erfolgreich ist, wird die Struktur mit den entsprechenden Werten aufgefüllt. Wenn diese Funktion fehlschlägt, enthält die Struktur nicht definierte Daten. |
JET_ColInfoByColid |
Wie JET_ColInfo wird PvResult als ein JET_COLUMNDEFinterpretiert, außer dieser InfoLevel gibt an, dass die angeforderte Spalte (SzColumName) nicht den Namen der Spalte Zeichenfolge, sondern einen Zeiger auf eine JET_COLUMNIDist. |
JET_ColInfoList |
PvResult wird als eine JET_COLUMNLIST -Struktur interpretiert. Wenn diese Funktion erfolgreich ist, wird die Struktur mit den entsprechenden Werten aufgefüllt. Eine temporäre Tabelle wird geöffnet, und Sie wird durch die Tabellen-ID Mitglied der JET_COLUMNLIST -Struktur identifiziert. Die Tabelle muss mit JetCloseTablegeschlossen werden. Wenn diese Funktion fehlschlägt, enthält die Struktur nicht definierte Daten. |
JET_ColInfoListCompact |
Identisch mit JET_ColInfoList. |
JET_ColInfoListSortColumnid |
Identisch mit JET_ColInfoList; jedoch ist die sich ergebende Tabelle Spalten-ID, statt Namens der Spalte sortiert. |
JET_ColInfoSysTabCursor |
JET_ColInfoSysTabCursor ist veraltet, und verwenden es gibt JET_errFeatureNotAvailable zurück. |
JET_ColInfoBaseByColId |
Wie JET_ColInfoBase PvResult als ein JET_COLUMNBASEinterpretiert wird, außer dieser InfoLevel angeforderte Spalte angibt (SzColumName) ist keine Zeichenfolge den Namen der Spalte, sondern einen Zeiger auf eine JET_COLUMNID. Windows Vista:Dieser Wert wird in Windows Vista eingeführt. |
JET_ColInfoGrbitNonDerivedColumnsOnly |
Nur zurück nicht abgeleitete Spalten (in der Tabelle von einer Vorlage abgeleitet ist). Dieser Wert kann logisch sein oder würde in der InfoLevel, wenn die Basis InfoLevel JET_ColInfoList ist. Windows Vista:Dieser Wert wird eingeführt Windows Vista. |
JET_ColInfoGrbitMinimalInfo |
Nur zurück, den Spaltennamen und die Spalten-ID der einzelnen Spalten. Dieser Wert kann logisch sein oder würde in der InfoLevel, wenn die Basis InfoLevel JET_ColInfoList ist. Windows Vista:Dieser Wert wird in Windows Vista eingeführt. |
JET_ColInfoGrbitSortByColumnid |
Sortieren von Columnid Spaltenliste zurückgegeben (Standard ist nach Spaltennamen sortieren). Dieser Wert kann logisch sein oder würde in der InfoLevel, wenn die Basis InfoLevel JET_ColInfoList ist. Windows Vista:Dieser Wert wird in Windows Vista eingeführt. |
Return Value
Diese Funktion gibt den Datentyp der JET_ERR mit einem der folgenden Rückgabecodes. Weitere Informationen zu den möglichen ESE-Fehlern finden Sie unter Extensible Storage Engine-Fehler und Fehler behandeln Parameter.
Rückgabecode |
Beschreibung |
---|---|
JET_errSuccess |
Der Vorgang wurde erfolgreich abgeschlossen. |
JET_errColumnNotFound |
Die Spalte mit dem Namen SzColumnName in der Tabelle nicht gefunden. |
JET_errFeatureNotAvailable |
Eine ungültige InfoLevel wurde angegeben. |
JET_errInvalidName |
Dieser Fehler kann zurückgegeben werden, wenn:
|
JET_errInvalidParameter |
Dieser Fehler kann zurückgegeben werden, wenn:
|
Anmerkungen
Abrufen von Informationen über eine Spalte sowohl JetGetTableColumnInfo als auch JetGetColumnInfo . Der Unterschied zwischen ihnen ist in der Tabelle identifiziert wird:
JetGetTableColumnInfo bezeichnet eine Tabelle von Tableid.
JetGetColumnInfo bezeichnet eine Tabelle durch Kombination von Dbid und SzTableName .
Beim Abrufen von Daten mit JET_ColInfoList, JET_ColInfoListSortColumnid oder JET_ColInfoListCompact, wird eine temporäre Tabelle geöffnet. Die temporäre Tabelle Daten enthält und die JET_COLUMNLIST -Struktur enthält genügend Informationen, um die temporäre Tabelle zu durchlaufen. Die temporäre Tabelle muss mit JetCloseTablegeschlossen werden.
Voraussetzungen
-Client, |
Erfordert Windows Vista, Windows XP oder Windows 2000 Professional. |
Server |
Erfordert WindowsServer 2008, WindowsServer 2003 oder Windows 2000 Server. |
Kopfzeile |
In Esent.h deklariert. |
Library |
Verwenden Sie ESENT.lib. |
DLL |
"ESENT.dll" erfordert. |
Unicode |
Implementiert als JetGetColumnInfoW (Unicode) und JetGetColumnInfoA (ANSI). |
Siehe auch
Parameter zur Fehlerbearbeitung
Fehler von Extensible Storage Engine
JET_COLUMNBASE
JET_COLUMNDEF
JET_COLUMNID
JET_COLUMNLIST
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetCloseTable
JetGetTableColumnInfo