JetGetObjectInfo, funkcja

Dotyczy: Windows | Windows Server

JetGetObjectInfo, funkcja

Funkcja JetGetObjectInfo pobiera informacje o obiektach bazy danych. Obecnie obsługiwane są tylko tabele. Funkcja JetGetTableInfo może służyć do pobierania większej ilości informacji niż JetGetObjectInfo.

    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
    );

Parametry

identyfikator sesid

Kontekst sesji bazy danych do użycia.

dbid

Baza danych, z której są pobierane informacje.

objtyp

Obiekty zawierające informacje do pobrania. Obecnie obsługiwane są tylko JET_objtypNil i JET_objtypTable, które zachowują się identycznie. Zostaną pobrane tylko tabele.

szContainerName

Ten parametr jest zarezerwowany do użycia w przyszłości i przekazuje wartość NULL. Nazwa typów obiektów, o których mają być pobierane informacje.

szObjectName

Nazwa obiektu zawierającego informacje do pobrania. Gdy program InfoLevel używa opcji JET_ObjInfoList lub JET_ObjInfoListNoStats w celu pobrania listy wszystkich obiektów, ta wartość powinna mieć wartość NULL lub pusty ciąg.

Obecnie obsługiwane są tylko nazwy tabel.

pvResult

Wskaźnik do buforu, który odbiera określone informacje.

Rozmiar buforu w bajtach jest przekazywany w cbMax. Po niepowodzeniu zawartość elementu pvResult jest niezdefiniowana.

Informacje przechowywane w pliku pvResult zależą od programu InfoLevel.

cbMax

Rozmiar w bajtach buforu przekazanego w trybie pvResult.

InfoLevel

Określa typ informacji do pobrania dla określonego obiektu. Ma to wpływ na sposób interpretowania pvResult .

Następujące opcje są dostępne do ustawienia dla tego parametru.

Wartość	Znaczenie
JET_ObjInfo	pvResult jest interpretowany jako struktura JET_OBJECTINFO . Struktura JET_OBJECTINFO jest wypełniana informacjami dotyczącymi obiektu o nazwie szObjectName. Jeśli obiekt wywołujący nie chce znać liczby rekordów i stron dla obiektu, rozważ użycie JET_ObjInfoNoStats poziomu informacji, co może być szybsze, ponieważ statystyki nie są uwzględniane.
JET_ObjInfoList	PvResult jest interpretowany jako struktura JET_OBJECTLIST . Pobierane są informacje o wszystkich obiektach. Zostanie utworzona tabela tymczasowa, a informacje niezbędne do przechodzenia przez tabelę tymczasową są opisane w strukturze JET_OBJECTLIST . Aby uzyskać więcej informacji, zobacz JET_OBJECTLIST. Jeśli obiekt wywołujący nie chce znać liczby rekordów i stron dla obiektu, rozważ użycie JET_ObjInfoListNoStats, co może być szybsze.
JET_ObjInfoListACM	Przestarzałe i obecnie nieobsługiwane.
JET_ObjInfoListNoStats	PvResult jest interpretowany jako struktura JET_OBJECTLIST . Pobierane są informacje o wszystkich obiektach. Zostanie utworzona tabela tymczasowa, a informacje niezbędne do przechodzenia przez tabelę tymczasową są opisane w strukturze JET_OBJECTLIST . Aby uzyskać więcej informacji, zobacz JET_OBJECTLIST. JET_ObjInfoListNoStats jest taka sama jak JET_ObjInfoList, z tą różnicą, że kolumny raportujące liczbę rekordów (columnidcRecord) i strony (columnidcPage) nie zostaną zaktualizowane.
JET_ObjInfoMax	pvResult jest interpretowany jako JET_OBJECTINFO. Maksymalny rozmiar obiektu znajduje się na stronach. Obecnie zostaną zwrócone tylko tabele.
JET_ObjInfoNoStats	pvResult jest interpretowany jako JET_OBJECTINFO. Zostaną pobrane informacje o tylko obiekcie podanym w szObjectName . Struktura JET_OBJECTINFO zostanie wypełniona informacjami dotyczącymi obiektu o nazwie szObjectName. JET_ObjInfoNoStats jest taka sama jak JET_ObjInfo, z tą różnicą, że pola raportujące liczbę rekordów i stron są ustawione na zero.
JET_ObjInfoRulesLoaded	Przestarzałe i obecnie nieobsługiwane.
JET_ObjInfoSysTabCursor	Przestarzałe i obecnie nieobsługiwane.
JET_ObjInfoSysTabReadOnly	Przestarzałe i obecnie nieobsługiwane.

Wartość zwracana

Ta funkcja zwraca JET_ERR typ danych z jednym z następujących kodów zwracanych. Aby uzyskać więcej informacji na temat możliwych błędów ESE, zobacz Extensible Storage Engine Errors and Error Handling Parameters (Błędy aparatu magazynu rozszerzalnego i parametry obsługi błędów).

Kod powrotny	Opis
JET_errSuccess	Operacja została ukończona pomyślnie.
JET_errBufferTooSmall	Rozmiar buforu podanego w cbMax był zbyt mały, aby przechowywać żądane informacje.
JET_errInvalidName	Podano nieprawidłową nazwę w szObjectName lub szContainerName.
JET_errInvalidParameter	Podano nieprawidłowy parametr. Istnieje możliwość, że do platformy InfoLevel przekazano nieprawidłowy poziom.

Uwagi

Jeśli obiekt JetGetObjectInfo pomyślnie utworzy tabelę tymczasową (na przykład JET_ObjInfoList lub JET_ObjInfoNoStats), obiekt wywołujący jest odpowiedzialny za zamknięcie tabeli tymczasowej za pomocą tabeli JetCloseTable.

JetGetObjectInfo obecnie obsługuje tylko pobieranie informacji o tabelach.

Wymagania

Wymaganie	Wartość
Klient	Wymaga systemu Windows Vista, Windows XP lub Windows 2000 Professional.
Serwer	Wymaga systemu Windows Server 2008, Windows Server 2003 lub Windows 2000 Server.
nagłówek	Zadeklarowany w Esent.h.
Biblioteka	Użyj biblioteki ESENT.lib.
DLL	Wymaga ESENT.dll.
Unicode	Zaimplementowane jako JetGetObjectInfoW (Unicode) i JetGetObjectInfoA (ANSI).

Zobacz też

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable
JetGetTableInfo