JetGetTableColumnInfo-Funktion

Letzte Änderung: Freitag, 27. Februar 2015

Gilt für: Windows | Windows Server

JetGetTableColumnInfo-Funktion

Die Funktion JetGetTableColumnInfo Ruft Informationen über eine Spalte einer Tabelle ab.

JET_ERR JET_API JetGetTableColumnInfo(
  __in          JET_SESID sesid,
  __in          JET_TABLEID tableid,
  __in          const tchar* szColumnName,
  __out         void* pvResult,
  __in          unsigned long cbMax,
  __in          unsigned long InfoLevel
);

Parameter

sesid

Der Kontext, für den API-Aufruf zu verwendenden Datenbank Sitzung.

TableID

Die Tabelle, die zum Abrufen von Informationen für die Spalte enthält.

szColumnName

Der Name der Spalte zum Abrufen von Informationen für.

pvResult

Zeiger auf einen Puffer, der Informationen zu erhalten. Der Typ des Puffers ist InfoLevelabhängig. Der Aufrufer muss konfiguriert sein, um Puffer entsprechend auszurichten.

cbMax

Die Größe des Puffers, der in PvResultübergeben wurde in Bytes.

InfoLevel

Der Typ der Informationen, die für die Spalte abgerufen werden sollen, die durch SzColumnNameangegeben ist. InfoLevelhängt das Format der Daten, die in PvResult gespeichert ist. Das Schema der temporären Tabelle finden Sie unter JET_COLUMNLIST.

• JET_ColInfoListSortColumnid wird die temporäre Tabelle nach Spalten-IDsortiert werden.

• JET_ColInfoListCompact wird die Ausgabe komprimieren. Weitere Informationen über die compact Ausgabe finden Sie unter JET_COLUMNLIST.

Die folgenden Optionen können für diesen Parameter festgelegt werden:

Wert	Bedeutung
JET_ColInfo	PvResult als ein JET_COLUMNDEFinterpretiert wird, und die Felder der Struktur JET_COLUMNDEF entsprechend ausgefüllt werden. JET_ColInfo und JET_ColInfoByColid abrufen die gleiche Informationen.
JET_ColInfoBase	PvResult wird als eine Struktur JET_COLUMNBASE interpretiert. Dies ist eine JET_COLUMNDEF Struktur ähnlich. 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	PvResult wird als eine JET_COLUMNDEFinterpretiert, mit der Ausnahme dieses InfoLevel gibt an, dass die angeforderte Spalte (SzColumName) nicht der Name der Spalte Zeichenfolge, sondern einen Zeiger auf eine JET_COLUMNIDist. JET_ColInfo und JET_ColInfoByColid abrufen die gleiche Informationen.
JET_ColInfoList	PvResult wird als eine Struktur JET_COLUMNLIST interpretiert. Wenn diese Funktion erfolgreich ist, wird die Struktur mit den entsprechenden Werten aufgefüllt. Eine temporäre Tabelle wird geöffnet und wird von der Tableid Mitglied JET_COLUMNLISTidentifiziert. Die Tabelle muss mit JetCloseTablegeschlossen werden. Wenn diese Funktion fehlschlägt, enthält die Struktur nicht definierte Daten.
JET_ColInfoListCompact	PvResult wird als eine Struktur JET_COLUMNLIST interpretiert. Wenn diese Funktion erfolgreich ist, wird die Struktur mit den entsprechenden Werten aufgefüllt. Eine temporäre Tabelle wird geöffnet und wird von der Tableid Mitglied JET_COLUMNLISTidentifiziert. Die Tabelle muss mit JetCloseTablegeschlossen werden. Wenn diese Funktion fehlschlägt, enthält die Struktur nicht definierte Daten.
JET_ColInfoListSortColumnid	Identisch mit JET_ColInfoList, wird jedoch die resultierende Tabelle nach Spalten-IDanstelle von Spaltennamen sortiert.
JET_ColInfoSysTabCursor	JET_ColInfoSysTabCursor ist veraltet, und sich gibt JET_errFeatureNotAvailable zurück.
JET_ColInfoBaseByColId	Identisch mit JET_ColInfoBase, PvResult wird als eine JET_COLUMNBASEinterpretiert, mit der Ausnahme dieses InfoLevel gibt die angeforderte Spalte an (SzColumName) ist nicht der Spaltenname der Zeichenfolge, aber ein Zeiger auf eine JET_COLUMNID. Windows Vista:Dies ist in Windows Vista und höher verfügbar.
JET_ColInfoGrbitNonDerivedColumnsOnly	Nur zurückgeben Sie nicht abgeleitete Spalten (falls die Tabelle aus einer Vorlage abgeleitet ist). Dieser Wert kann logisch sein oder in der InfoLevelwürde, wenn die Basis InfoLevel JET_ColInfoList ist. Windows Vista:Dieser Wert wird in Windows Vista eingeführt.
JET_ColInfoGrbitMinimalInfo	Nur zurückgegeben Sie den Spaltennamen und die Spalten-ID der einzelnen Spalten werden. Dieser Wert kann logisch sein oder in der InfoLevelwürde, wenn die Basis InfoLevel JET_ColInfoList ist. Windows Vista:Dieser Wert wird in Windows Vista eingeführt.
JET_ColInfoGrbitSortByColumnid	Sortieren der zurückgegebenen Spaltenliste von Spalten-ID (Standard ist Spaltenname Liste Sortierattribut an). Dieser Wert kann logisch sein oder in der InfoLevelwürde, wenn die Basis InfoLevel JET_ColInfoList ist. Windows Vista:Dieser Wert wird in Windows Vista 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_errColumnNotFound	Die Spalte mit dem Namen SzColumnName in der Tabelle nicht gefunden.
JET_errFeatureNotAvailable	Es wurde eine ungültige InfoLevel angegeben.
JET_errInvalidName	Dieser Fehler kann zurückgegeben werden, wenn: Es wurde ein ungültiger Name für SzTableName angegeben. Es wurde ein ungültiger Name für SzColumnName angegeben.
JET_errInvalidParameter	Dieser Fehler kann zurückgegeben werden, wenn: Es wurde eine ungültige InfoLevel angegeben. Ein NULL- SzTableName wurde übergeben. Der Puffer ist zu klein.

Anmerkungen

Abrufen von Informationen über eine Spalte JetGetTableColumnInfo und JetGetColumnInfo . Der Unterschied zwischen diesen ist in der Tabelle identifiziert wird:

• JetGetTableColumnInfo identifiziert eine Tabelle nach Tableid.

• JetGetColumnInfo bezeichnet eine Tabelle durch Kombination Dbid und SzTableName .

Beim Abrufen von Daten mit JET_ColInfoList, JET_ColInfoListSortColumnid oder JET_ColInfoListCompact, wird eine temporäre Tabelle geöffnet werden. Die temporäre Tabelle Daten enthält, und die JET_COLUMNLIST -Datenstruktur 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	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 JetGetTableColumnInfoW (Unicode) und JetGetTableColumnInfoA (ANSI).

Siehe auch

Fehler der Extensible Storage Engine
Fehler Behandlung Parameter
JET_COLUMNBASE
JET_COLUMNDEF
JET_COLUMNID
JET_COLUMNLIST
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetCloseTable
JetGetColumnInfo
JetGetTableColumnInfo