JetGetObjectInfo-funktion

gäller för: Windows | Windows Server

JetGetObjectInfo-funktion

Funktionen JetGetObjectInfo hämtar information om databasobjekt. För närvarande stöds endast tabeller. JetGetTableInfo kan användas för att hämta mer information än 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
    );

Parameterar

sesid

Den databassessionskontext som ska användas.

dbid

Databasen som informationen hämtas från.

objtyp

De objekt som innehåller information som ska hämtas. För närvarande stöds endast JET_objtypNil och JET_objtypTable, som båda fungerar identiskt. Endast tabeller hämtas.

szContainerName

Den här parametern är reserverad för framtida användning och skickar NULL. Namnet på de typer av objekt som information ska hämtas om.

szObjectName

Namnet på objektet som innehåller information som ska hämtas. När InfoLevel använder alternativen JET_ObjInfoList eller JET_ObjInfoListNoStats för att hämta en lista över alla objekt ska värdet vara NULL eller en tom sträng.

Endast tabellnamn stöds för närvarande.

pvResult

Pekare till en buffert som tar emot den angivna informationen.

Buffertens storlek i byte skickas i cbMax. Vid fel är innehållet i pvResult odefinierat.

Den information som lagras i pvResult beror på InfoLevel.

cbMax

Storleken, i byte, på bufferten som skickades i pvResult.

InfoLevel

Anger vilken typ av information som ska hämtas för det angivna objektet. Det påverkar hur pvResult tolkas.

Följande alternativ är tillgängliga för den här parametern.

Värde	Innebörd
JET_ObjInfo	pvResult tolkas som en JET_OBJECTINFO struktur. Den JET_OBJECTINFO strukturen fylls i med information som rör objektet som heter i szObjectName. Om anroparen inte vill veta antalet poster och sidor för objektet bör du överväga att använda JET_ObjInfoNoStats informationsnivå, vilket kan gå snabbare eftersom statistik inte ingår.
JET_ObjInfoList	pvResult tolkas som en JET_OBJECTLIST struktur. Information om alla objekt hämtas. En tillfällig tabell skapas och den information som krävs för att passera den tillfälliga tabellen beskrivs i den JET_OBJECTLIST strukturen. Mer information finns i JET_OBJECTLIST. Om anroparen inte vill veta antalet poster och sidor för objektet bör du överväga att använda JET_ObjInfoListNoStats, vilket kan gå snabbare.
JET_ObjInfoListACM	Inaktuell och stöds inte för närvarande.
JET_ObjInfoListNoStats	pvResult tolkas som en JET_OBJECTLIST struktur. Information om alla objekt hämtas. En tillfällig tabell skapas och den information som krävs för att passera den tillfälliga tabellen beskrivs i den JET_OBJECTLIST strukturen. Mer information finns i JET_OBJECTLIST. JET_ObjInfoListNoStats är identisk med JET_ObjInfoList, förutom att kolumnerna som rapporterar antalet poster (columnidcRecord) och sidor (columnidcPage) inte uppdateras.
JET_ObjInfoMax	pvResult tolkas som en JET_OBJECTINFO. Objektets maximala storlek finns på sidor. För närvarande returneras endast tabeller.
JET_ObjInfoNoStats	pvResult tolkas som en JET_OBJECTINFO. Information om endast det objekt som anges i szObjectName hämtas. Den JET_OBJECTINFO strukturen fylls i med information om objektet som heter i szObjectName. JET_ObjInfoNoStats är identisk med JET_ObjInfo, förutom att fälten som rapporterar antalet poster och sidor är inställda på noll.
JET_ObjInfoRulesLoaded	Inaktuell och stöds inte för närvarande.
JET_ObjInfoSysTabCursor	Inaktuell och stöds inte för närvarande.
JET_ObjInfoSysTabReadOnly	Inaktuell och stöds inte för närvarande.

Returvärde

Den här funktionen returnerar JET_ERR-datatypen med någon av följande returkoder. Mer information om möjliga ESE-fel finns i Extensible Storage Engine Errors and Error Handling Parameters (Utökningsbara lagringsmotorfel och felhanteringsparametrar).

Returkod	Beskrivning
JET_errSuccess	Åtgärden har slutförts.
JET_errBufferTooSmall	Storleken på bufferten som angavs i cbMax var för liten för att innehålla önskad information.
JET_errInvalidName	Ett ogiltigt namn angavs i szObjectName eller szContainerName.
JET_errInvalidParameter	En felaktig parameter angavs. Det är möjligt att en dålig nivå skickades in till InfoLevel.

Anmärkningar

Om JetGetObjectInfo skapar en tillfällig tabell (till exempel JET_ObjInfoList eller JET_ObjInfoNoStats) ansvarar anroparen för att stänga den tillfälliga tabellen med JetCloseTable.

JetGetObjectInfo stöder för närvarande endast hämtning av information om tabeller.

Krav

Krav	Värde
Klient	Kräver Windows Vista, Windows XP eller Windows 2000 Professional.
Server	Kräver Windows Server 2008, Windows Server 2003 eller Windows 2000 Server.
Rubrik	Deklarerad i Esent.h.
Bibliotek	Använd ESENT.lib.
DLL	Kräver ESENT.dll.
Unicode	Implementerad som JetGetObjectInfoW (Unicode) och JetGetObjectInfoA (ANSI).

Se även

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable
JetGetTableInfo