JetGetObjectInfo – funkce

platí pro: Windows | Windows Server

JetGetObjectInfo – funkce

Funkce JetGetObjectInfo načte informace o databázových objektech. V současné době se podporují jenom tabulky. JetGetTableInfo lze použít k načtení více informací než 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

sesid

Kontext relace databáze, který se má použít.

dbid

Databáze, ze které jsou informace načteny.

objtyp

Objekty obsahující informace, které se mají načíst. V současné době se podporují pouze JET_objtypNil a JET_objtypTable, přičemž oba se chovají stejně. Načtou se jenom tabulky.

szContainerName

Tento parametr je vyhrazen pro budoucí použití a předává hodnotu NULL. Název typů objektů, o kterých se mají načíst informace.

szObjectName

Název objektu, který obsahuje informace k načtení. Pokud InfoLevel používá možnosti JET_ObjInfoList nebo JET_ObjInfoListNoStats k načtení seznamu všech objektů, tato hodnota by měla být NULL nebo prázdný řetězec.

V současné době se podporují jenom názvy tabulek.

pvResult

Ukazatel na vyrovnávací paměť, která přijímá zadané informace.

Velikost vyrovnávací paměti v bajtech se předává v cbMax. Při selhání se obsah pvResult nedefinuje.

Informace uložené v pvResult závisí na úrovni InfoLevel.

cbMax

Velikost vyrovnávací paměti předané v bajtech v pvResult.

InfoLevel

Určuje typ informací, které se mají načíst pro zadaný objekt. Ovlivňuje způsob interpretace pvResult .

Pro tento parametr jsou k dispozici následující možnosti.

Hodnota	Význam
JET_ObjInfo	PvResult se interpretuje jako JET_OBJECTINFO struktura. Struktura JET_OBJECTINFO je naplněna informacemi týkajícími se objektu, který je pojmenován v szObjectName. Pokud volající nechce znát počet záznamů a stránek objektu, zvažte použití úrovně informací JET_ObjInfoNoStats, což může být rychlejší, protože statistiky nejsou zahrnuty.
JET_ObjInfoList	PvResult se interpretuje jako JET_OBJECTLIST struktura. Načtou se informace o všech objektech. Vytvoří se dočasná tabulka a informace potřebné k procházení dočasné tabulky jsou popsány ve struktuře JET_OBJECTLIST . Další informace najdete v tématu JET_OBJECTLIST. Pokud volající nechce znát počet záznamů a stránek objektu, zvažte použití JET_ObjInfoListNoStats, což může být rychlejší.
JET_ObjInfoListACM	Zastaralé a aktuálně se nepodporují.
JET_ObjInfoListNoStats	PvResult se interpretuje jako JET_OBJECTLIST struktura. Načtou se informace o všech objektech. Vytvoří se dočasná tabulka a informace potřebné k procházení dočasné tabulky jsou popsány ve struktuře JET_OBJECTLIST . Další informace najdete v tématu JET_OBJECTLIST. JET_ObjInfoListNoStats je shodná s JET_ObjInfoList, s výjimkou sloupců, které hlásí počet záznamů (columnidcRecord) a stránek (columnidcPage), nebudou aktualizovány.
JET_ObjInfoMax	PvResult se interpretuje jako JET_OBJECTINFO. Maximální velikost objektu je na stránkách. V současné době budou vráceny pouze tabulky.
JET_ObjInfoNoStats	PvResult se interpretuje jako JET_OBJECTINFO. Informace o pouze objektu zadaném v szObjectName budou načteny. Struktura JET_OBJECTINFO bude naplněna informacemi týkajícími se objektu, který je pojmenován v szObjectName. JET_ObjInfoNoStats je shodná s JET_ObjInfo s tím rozdílem, že pole, která hlásí počet záznamů a stránek, jsou nastavená na nulu.
JET_ObjInfoRulesLoaded	Zastaralé a aktuálně se nepodporují.
JET_ObjInfoSysTabCursor	Zastaralé a aktuálně se nepodporují.
JET_ObjInfoSysTabReadOnly	Zastaralé a aktuálně se nepodporují.

Návratová hodnota

Tato funkce vrátí datový typ JET_ERR s jedním z následujících návratových kódů. Další informace o možných chybách ESE naleznete v tématu Rozšiřitelné chyby modulu úložiště a parametry zpracování chyb.

Návratový kód	Popis
JET_errSuccess	Operace byla úspěšně dokončena.
JET_errBufferTooSmall	Velikost vyrovnávací paměti uvedené v cbMax byla příliš malá na uložení požadovaných informací.
JET_errInvalidName	Neplatný název byl uveden v szObjectName nebo szContainerName.
JET_errInvalidParameter	Byl udělen chybný parametr. Je možné, že do úrovně InfoLevel byla předána špatná úroveň.

Poznámky

Pokud JetGetObjectInfo úspěšně vytvoří dočasnou tabulku (například JET_ObjInfoList nebo JET_ObjInfoNoStats), volající je zodpovědný za zavření dočasné tabulky pomocí JetCloseTable.

JetGetObjectInfo aktuálně podporuje pouze načítání informací o tabulkách.

Požadavky

Požadavek	Hodnota
Klient	Vyžaduje systém Windows Vista, Windows XP nebo Windows 2000 Professional.
Server	Vyžaduje Systém Windows Server 2008, Windows Server 2003 nebo Windows 2000 Server.
záhlaví	Deklarováno v esent.h.
Knihovna	Použijte ESENT.lib.
DLL knihovny	Vyžaduje ESENT.dll.
unicode	Implementováno jako JetGetObjectInfoW (Unicode) a JetGetObjectInfoA (ANSI).

Viz také

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
jetCloseTable
JetGetTableInfo