Funzione JetGetObjectInfo

Articolo
06/13/2023

Si applica a: Windows | Windows Server

Funzione JetGetObjectInfo

La funzione JetGetObjectInfo recupera informazioni sugli oggetti di database. Attualmente sono supportate solo le tabelle. JetGetTableInfo può essere usato per recuperare altre informazioni rispetto a 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
    );

Parametri

sesid

Contesto della sessione del database da utilizzare.

dbid

Database da cui vengono recuperate le informazioni.

objtyp

Oggetti che contengono informazioni da recuperare. Attualmente sono supportati solo JET_objtypNil e JET_objtypTable, che si comportano in modo identico. Verranno recuperate solo le tabelle.

szContainerName

Questo parametro è riservato per uso futuro e passa NULL. Nome dei tipi di oggetti su cui recuperare le informazioni.

szObjectName

Nome dell'oggetto che contiene informazioni da recuperare. Quando InfoLevel usa le opzioni JET_ObjInfoList o JET_ObjInfoListNoStats per recuperare un elenco di tutti gli oggetti, questo valore deve essere NULL o una stringa vuota.

Attualmente sono supportati solo i nomi di tabella.

pvResult

Puntatore a un buffer che riceve le informazioni specificate.

Le dimensioni del buffer, in byte, vengono passate in cbMax. In caso di errore, il contenuto di pvResult non è definito.

Le informazioni archiviate in pvResult dipendono da InfoLevel.

cbMax

Dimensione, in byte, del buffer passato in pvResult.

InfoLevel

Specifica il tipo di informazioni da recuperare per l'oggetto specificato. Influisce sulla modalità di interpretazione di pvResult .

Per questo parametro sono disponibili le opzioni seguenti.

Valore	Significato
JET_ObjInfo	pvResult viene interpretato come struttura JET_OBJECTINFO . La struttura JET_OBJECTINFO viene popolata con informazioni relative all'oggetto denominato in szObjectName. Se il chiamante non vuole conoscere il numero di record e pagine per l'oggetto, è consigliabile usare JET_ObjInfoNoStats livello di informazioni, che potrebbe essere più veloce perché le statistiche non sono incluse.
JET_ObjInfoList	pvResult viene interpretato come struttura JET_OBJECTLIST . Vengono recuperate informazioni su tutti gli oggetti. Verrà creata una tabella temporanea e le informazioni necessarie per attraversare la tabella temporanea vengono descritte nella struttura JET_OBJECTLIST . Per altre informazioni, vedere JET_OBJECTLIST. Se il chiamante non vuole conoscere il numero di record e pagine per l'oggetto, è consigliabile usare JET_ObjInfoListNoStats, che potrebbe essere più veloce.
JET_ObjInfoListACM	Deprecato e non attualmente supportato.
JET_ObjInfoListNoStats	pvResult viene interpretato come struttura JET_OBJECTLIST . Vengono recuperate informazioni su tutti gli oggetti. Verrà creata una tabella temporanea e le informazioni necessarie per attraversare la tabella temporanea vengono descritte nella struttura JET_OBJECTLIST . Per altre informazioni, vedere JET_OBJECTLIST. JET_ObjInfoListNoStats è identico a JET_ObjInfoList, ad eccezione del fatto che le colonne che segnalano il numero di record (columnidcRecord) e le pagine (columnidcPage) non verranno aggiornate.
JET_ObjInfoMax	pvResult viene interpretato come un JET_OBJECTINFO. La dimensione massima dell'oggetto è in pagine. Verranno restituite solo le tabelle.
JET_ObjInfoNoStats	pvResult viene interpretato come un JET_OBJECTINFO. Verranno recuperate informazioni solo sull'oggetto specificato in szObjectName . La struttura JET_OBJECTINFO verrà popolata con informazioni relative all'oggetto denominato in szObjectName. JET_ObjInfoNoStats è identico a JET_ObjInfo, ad eccezione del fatto che i campi che segnalano il numero di record e pagine sono impostati su zero.
JET_ObjInfoRulesLoaded	Deprecato e non attualmente supportato.
JET_ObjInfoSysTabCursor	Deprecato e non attualmente supportato.
JET_ObjInfoSysTabReadOnly	Deprecato e non attualmente supportato.

Valore restituito

Questa funzione restituisce il tipo di dati JET_ERR con uno dei codici restituiti seguenti. Per altre informazioni sui possibili errori ESE, vedere Errori del motore di archiviazione estendibile e parametri di gestione degli errori.

Codice restituito	Descrizione
JET_errSuccess	Operazione riuscita.
JET_errBufferTooSmall	La dimensione del buffer specificato in cbMax era troppo piccola per contenere le informazioni desiderate.
JET_errInvalidName	È stato assegnato un nome non valido in szObjectName o szContainerName.
JET_errInvalidParameter	È stato specificato un parametro non valido. È possibile che un livello non valido sia stato passato a InfoLevel.

Commenti

Se JetGetObjectInfo crea correttamente una tabella temporanea, ad esempio JET_ObjInfoList o JET_ObjInfoNoStats, il chiamante è responsabile della chiusura della tabella temporanea con JetCloseTable.

JetGetObjectInfo supporta attualmente solo il recupero di informazioni sulle tabelle.

Requisiti

Requisito	Valore
Client	Richiede Windows Vista, Windows XP o Windows 2000 Professional.
Server	Richiede Windows Server 2008, Windows Server 2003 o Windows 2000 Server.
Intestazione	Dichiarato in Esent.h.
Libreria	Usare ESENT.lib.
DLL	Richiede ESENT.dll.
Unicode	Implementato come JetGetObjectInfoW (Unicode) e JetGetObjectInfoA (ANSI).

Vedere anche

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable
JetGetTableInfo

Condividi tramite

Funzione JetGetObjectInfo