JetGetObjectInfo-Funktion

Gilt für: Windows | Windows Server

JetGetObjectInfo-Funktion

Die JetGetObjectInfo-Funktion ruft Informationen zu Datenbankobjekten ab. Derzeit werden nur Tabellen unterstützt. JetGetTableInfo kann verwendet werden, um mehr Informationen als JetGetObjectInfo abzurufen.

    JET_ERR JET_API JetGetObjectInfo(
      __in          JET_SESID sesid,
      __in          JET_DBID dbid,
      __in          JET_OBJTYP objtyp,
      __in_opt      const tchar* szContainerName,
      __in_opt      const tchar* szObjectName,
      __out         void* pvResult,
      __in          unsigned long cbMax,
      __in          unsigned long InfoLevel
    );

Parameter

sesid

Der zu verwendende Datenbanksitzungskontext.

dbid

Die Datenbank, aus der die Informationen abgerufen werden.

objtyp

Die Objekte, die abzurufende Informationen enthalten. Derzeit werden nur JET_objtypNil und JET_objtypTable unterstützt, die sich beide identisch verhalten. Es werden nur Tabellen abgerufen.

szContainerName

Dieser Parameter ist für die zukünftige Verwendung reserviert und übergibt NULL. Der Name der Objekttypen, über die Informationen abgerufen werden sollen.

szObjectName

Der Name des Objekts, das abzurufende Informationen enthält. Wenn InfoLevel die Optionen JET_ObjInfoList oder JET_ObjInfoListNoStats verwendet, um eine Liste aller Objekte abzurufen, sollte dieser Wert NULL oder eine leere Zeichenfolge sein.

Derzeit werden nur Tabellennamen unterstützt.

pvResult

Zeiger auf einen Puffer, der die angegebenen Informationen empfängt.

Die Größe des Puffers in Bytes wird in cbMax übergeben. Bei Einem Fehler ist der Inhalt von pvResult nicht definiert.

Die in pvResult gespeicherten Informationen hängen von InfoLevel ab.

cbMax

Die Größe des in pvResult übergebenen Puffers in Bytes.

InfoLevel

Gibt an, welcher Informationstyp für das angegebene Objekt abgerufen werden soll. Dies wirkt sich darauf aus, wie pvResult interpretiert wird.

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

Wert	Bedeutung
JET_ObjInfo	pvResult wird als JET_OBJECTINFO-Struktur interpretiert. Die JET_OBJECTINFO Struktur wird mit Informationen zum Objekt aufgefüllt, das in szObjectName benannt ist. Wenn der Aufrufer die Anzahl der Datensätze und Seiten für das Objekt nicht kennen möchte, erwägen Sie die Verwendung JET_ObjInfoNoStats Informationsebene, die möglicherweise schneller ist, da keine Statistiken enthalten sind.
JET_ObjInfoList	pvResult wird als JET_OBJECTLIST-Struktur interpretiert. Informationen zu allen Objekten werden abgerufen. Es wird eine temporäre Tabelle erstellt, und die Informationen, die zum Durchlaufen der temporären Tabelle erforderlich sind, werden in der JET_OBJECTLIST-Struktur beschrieben. Weitere Informationen finden Sie unter JET_OBJECTLIST. Wenn der Aufrufer die Anzahl der Datensätze und Seiten für das Objekt nicht kennen möchte, sollten Sie JET_ObjInfoListNoStats verwenden, was möglicherweise schneller ist.
JET_ObjInfoListACM	Veraltet und derzeit nicht unterstützt.
JET_ObjInfoListNoStats	pvResult wird als JET_OBJECTLIST-Struktur interpretiert. Informationen zu allen Objekten werden abgerufen. Es wird eine temporäre Tabelle erstellt, und die Informationen, die zum Durchlaufen der temporären Tabelle erforderlich sind, werden in der JET_OBJECTLIST-Struktur beschrieben. Weitere Informationen finden Sie unter JET_OBJECTLIST. JET_ObjInfoListNoStats ist mit JET_ObjInfoList identisch, mit der Ausnahme, dass die Spalten, die die Anzahl der Datensätze (columnidcRecord) und Seiten (columnidcPage) angeben, nicht aktualisiert werden.
JET_ObjInfoMax	pvResult wird als JET_OBJECTINFO interpretiert. Die maximale Größe des Objekts liegt in Seiten. Derzeit werden nur Tabellen zurückgegeben.
JET_ObjInfoNoStats	pvResult wird als JET_OBJECTINFO interpretiert. Es werden nur Informationen über das objekt abgerufen, das in szObjectName angegeben ist. Die JET_OBJECTINFO-Struktur wird mit Informationen zum Objekt aufgefüllt, das in szObjectName benannt ist. JET_ObjInfoNoStats ist mit JET_ObjInfo identisch, mit der Ausnahme, dass die Felder, die die Anzahl von Datensätzen und Seiten melden, auf Null festgelegt sind.
JET_ObjInfoRulesLoaded	Veraltet und derzeit nicht unterstützt.
JET_ObjInfoSysTabCursor	Veraltet und derzeit nicht unterstützt.
JET_ObjInfoSysTabReadOnly	Veraltet und derzeit nicht unterstützt.

Rückgabewert

Diese Funktion gibt den JET_ERR-Datentyp mit einem der folgenden Rückgabecodes zurück. Weitere Informationen zu möglichen ESE-Fehlern finden Sie unter Erweiterbare Speichermodulfehler und Fehlerbehandlungsparameter.

Rückgabecode	Beschreibung
JET_errSuccess	Der Vorgang wurde erfolgreich abgeschlossen.
JET_errBufferTooSmall	Die Größe des Puffers in cbMax war zu klein, um die gewünschten Informationen aufzunehmen.
JET_errInvalidName	In szObjectName oder szContainerName wurde ein ungültiger Name angegeben.
JET_errInvalidParameter	Ein ungültiger Parameter wurde angegeben. Es ist möglich, dass eine schlechte Ebene an InfoLevel übergeben wurde.

Bemerkungen

Wenn JetGetObjectInfo erfolgreich eine temporäre Tabelle erstellt (z. B. JET_ObjInfoList oder JET_ObjInfoNoStats), ist der Aufrufer für das Schließen der temporären Tabelle mit JetCloseTable verantwortlich.

JetGetObjectInfo unterstützt derzeit nur das Abrufen von Informationen zu Tabellen.

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.
Kopfzeile	Deklariert in Esent.h.
Bibliothek	Verwenden Sie ESENT.lib.
DLL	Erfordert ESENT.dll.
Unicode	Implementiert als JetGetObjectInfoW (Unicode) und JetGetObjectInfoA (ANSI).

Weitere Informationen

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable
JetGetTableInfo