JetGetObjectInfo, functie

van toepassing op: Windows | Windows Server

JetGetObjectInfo, functie

De functie JetGetObjectInfo haalt informatie over databaseobjecten op. Momenteel worden alleen tabellen ondersteund. JetGetTableInfo kan worden gebruikt om meer informatie op te halen dan 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
    );

Parameterwaarden

sesid

De context van de databasesessie die moet worden gebruikt.

dbid

De database waaruit de gegevens worden opgehaald.

objtyp-

De objecten die informatie bevatten die moeten worden opgehaald. Op dit moment worden alleen JET_objtypNil en JET_objtypTable ondersteund, die beide identiek werken. Alleen tabellen worden opgehaald.

szContainerName

Deze parameter is gereserveerd voor toekomstig gebruik en geeft NULL door. De naam van de typen objecten waarover informatie moet worden opgehaald.

szObjectName

De naam van het object dat informatie bevat die moet worden opgehaald. Wanneer InfoLevel de JET_ObjInfoList of JET_ObjInfoListNoStats opties gebruikt om een lijst met alle objecten op te halen, moet deze waarde NULL of een lege tekenreeks zijn.

Momenteel worden alleen tabelnamen ondersteund.

pvResult

Wijs een buffer aan die de opgegeven informatie ontvangt.

De grootte van de buffer, in bytes, wordt doorgegeven in cbMax. Bij een fout is de inhoud van pvResult niet gedefinieerd.

De informatie die is opgeslagen in pvResult , is afhankelijk van InfoLevel.

cbMax-

De grootte, in bytes, van de buffer die is doorgegeven in pvResult.

InfoLevel

Hiermee geeft u op welk type informatie moet worden opgehaald voor het opgegeven object. Dit is van invloed op hoe pvResult wordt geïnterpreteerd.

De volgende opties zijn beschikbaar om in te stellen voor deze parameter.

Waarde	Betekenis
JET_ObjInfo	pvResult wordt geïnterpreteerd als een JET_OBJECTINFO structuur. De JET_OBJECTINFO structuur wordt gevuld met informatie met betrekking tot het object met de naam in szObjectName. Als de beller het aantal records en pagina's voor het object niet wil weten, kunt u overwegen om JET_ObjInfoNoStats informatieniveau te gebruiken, wat mogelijk sneller is omdat statistieken niet zijn opgenomen.
JET_ObjInfoList	pvResult wordt geïnterpreteerd als een JET_OBJECTLIST structuur. Informatie over alle objecten wordt opgehaald. Er wordt een tijdelijke tabel gemaakt en de informatie die nodig is om de tijdelijke tabel te doorlopen, wordt beschreven in de JET_OBJECTLIST structuur. Zie JET_OBJECTLIST voor meer informatie. Als de aanroeper het aantal records en pagina's voor het object niet wil weten, kunt u overwegen om JET_ObjInfoListNoStats te gebruiken. Dit kan sneller zijn.
JET_ObjInfoListACM	Afgeschaft en momenteel niet ondersteund.
JET_ObjInfoListNoStats	pvResult wordt geïnterpreteerd als een JET_OBJECTLIST structuur. Informatie over alle objecten wordt opgehaald. Er wordt een tijdelijke tabel gemaakt en de informatie die nodig is om de tijdelijke tabel te doorlopen, wordt beschreven in de JET_OBJECTLIST structuur. Zie JET_OBJECTLIST voor meer informatie. JET_ObjInfoListNoStats is identiek aan JET_ObjInfoList, behalve dat de kolommen die het aantal records (columnidcRecord) en pagina's (columnidcPage) rapporteren, niet worden bijgewerkt.
JET_ObjInfoMax	pvResult wordt geïnterpreteerd als een JET_OBJECTINFO. De maximale grootte van het object bevindt zich in pagina's. Op dit moment worden alleen tabellen geretourneerd.
JET_ObjInfoNoStats	pvResult wordt geïnterpreteerd als een JET_OBJECTINFO. Informatie over alleen het object dat in szObjectName wordt gegeven, wordt opgehaald. De JET_OBJECTINFO structuur wordt gevuld met informatie over het object met de naam in szObjectName. JET_ObjInfoNoStats is identiek aan JET_ObjInfo, behalve dat de velden die het aantal records en pagina's rapporteren, zijn ingesteld op nul.
JET_ObjInfoRulesLoaded	Afgeschaft en momenteel niet ondersteund.
JET_ObjInfoSysTabCursor	Afgeschaft en momenteel niet ondersteund.
JET_ObjInfoSysTabReadOnly	Afgeschaft en momenteel niet ondersteund.

Retourwaarde

Met deze functie wordt het JET_ERR gegevenstype geretourneerd met een van de volgende retourcodes. Zie Extensible Storage Engine Errors and Error Handling Parameters (Extensible Storage Engine Errors and Error Handling Parameters) (Extensible Storage Engine Errors and Error Handling Parameters) voor meer informatie over de mogelijke ESE-fouten.

Retourcode	Beschrijving
JET_errSuccess	De bewerking is voltooid.
JET_errBufferTooSmall	De grootte van de buffer in cbMax was te klein om de gewenste informatie te bevatten.
JET_errInvalidName	Er is een ongeldige naam opgegeven in szObjectName of szContainerName.
JET_errInvalidParameter	Er is een ongeldige parameter opgegeven. Het is mogelijk dat een slecht niveau is doorgegeven aan InfoLevel.

Opmerkingen

Als JetGetObjectInfo een tijdelijke tabel maakt (bijvoorbeeld JET_ObjInfoList of JET_ObjInfoNoStats), is de aanroeper verantwoordelijk voor het sluiten van de tijdelijke tabel met JetCloseTable.

JetGetObjectInfo ondersteunt momenteel alleen het ophalen van informatie over tabellen.

Vereisten

Voorwaarde	Waarde
Client	Vereist Windows Vista, Windows XP of Windows 2000 Professional.
Server	Vereist Windows Server 2008, Windows Server 2003 of Windows 2000 Server.
koptekst	Gedeclareerd in Esent.h.
Bibliotheek	Gebruik ESENT.lib.
DLL	Vereist ESENT.dll.
Unicode-	Geïmplementeerd als JetGetObjectInfoW (Unicode) en JetGetObjectInfoA (ANSI).

Zie ook

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable-
JetGetTableInfo-