Partager via

Fonction JetGetObjectInfo

s’applique à : Windows | Windows Server

Fonction JetGetObjectInfo

La fonction JetGetObjectInfo récupère des informations sur les objets de base de données. Actuellement, seules les tables sont prises en charge. JetGetTableInfo peut être utilisé pour récupérer plus d’informations que 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
    );

Paramètres

sesid

Contexte de session de base de données à utiliser.

dbid

Base de données à partir de laquelle les informations sont récupérées.

objtyp

Objets qui contiennent des informations à récupérer. Actuellement, seules les JET_objtypNil et les JET_objtypTable sont prises en charge, qui se comportent toutes deux de manière identique. Seules les tables seront récupérées.

szContainerName

Ce paramètre est réservé pour une utilisation ultérieure et passe NULL. Nom des types d’objets sur lesquels récupérer des informations.

szObjectName

Nom de l’objet qui contient des informations à récupérer. Lorsque InfoLevel utilise les options JET_ObjInfoList ou JET_ObjInfoListNoStats pour récupérer une liste de tous les objets, cette valeur doit être NULL ou une chaîne vide.

Seuls les noms de tables sont actuellement pris en charge.

pvResult

Pointeur vers une mémoire tampon qui reçoit les informations spécifiées.

La taille de la mémoire tampon, en octets, est passée en cbMax. En cas de défaillance, le contenu de pvResult n’est pas défini.

Les informations stockées dans pvResult dépendent d’InfoLevel.

cbMax

Taille, en octets, de la mémoire tampon passée en pvResult.

InfoLevel

Spécifie le type d’informations à récupérer pour l’objet spécifié. Elle affecte la façon dont pvResult est interprété.

Les options suivantes sont disponibles pour définir ce paramètre.

Valeur

Sens

JET_ObjInfo

pvResult est interprété comme une structure JET_OBJECTINFO .

La structure JET_OBJECTINFO est remplie avec des informations relatives à l’objet nommé dans szObjectName.

Si l’appelant ne souhaite pas connaître le nombre d’enregistrements et de pages de l’objet, envisagez d’utiliser JET_ObjInfoNoStats niveau d’informations, ce qui peut être plus rapide, car les statistiques ne sont pas incluses.

JET_ObjInfoList

pvResult est interprété comme une structure JET_OBJECTLIST . Des informations sur tous les objets sont récupérées. Une table temporaire est créée et les informations nécessaires pour parcourir la table temporaire sont décrites dans la structure JET_OBJECTLIST . Pour plus d’informations, consultez JET_OBJECTLIST. Si l’appelant ne souhaite pas connaître le nombre d’enregistrements et de pages de l’objet, envisagez d’utiliser JET_ObjInfoListNoStats, ce qui peut être plus rapide.

JET_ObjInfoListACM

Déconseillé et non pris en charge actuellement.

JET_ObjInfoListNoStats

pvResult est interprété comme une structure JET_OBJECTLIST . Des informations sur tous les objets sont récupérées. Une table temporaire est créée et les informations nécessaires pour parcourir la table temporaire sont décrites dans la structure JET_OBJECTLIST . Pour plus d’informations, consultez JET_OBJECTLIST. JET_ObjInfoListNoStats est identique à JET_ObjInfoList, sauf que les colonnes qui signalent le nombre d’enregistrements (columnidcRecord) et les pages (columnidcPage) ne sont pas mises à jour.

JET_ObjInfoMax

pvResult est interprété comme une JET_OBJECTINFO. La taille maximale de l’objet se trouve dans les pages. Actuellement, seules les tables seront retournées.

JET_ObjInfoNoStats

pvResult est interprété comme une JET_OBJECTINFO. Des informations sur l’objet donné dans szObjectName sont récupérées.

La structure JET_OBJECTINFO est remplie avec des informations relatives à l’objet nommé dans szObjectName.

JET_ObjInfoNoStats est identique à JET_ObjInfo, sauf que les champs qui signalent le nombre d’enregistrements et de pages sont définis sur zéro.

JET_ObjInfoRulesLoaded

Déconseillé et non pris en charge actuellement.

JET_ObjInfoSysTabCursor

Déconseillé et non pris en charge actuellement.

JET_ObjInfoSysTabReadOnly

Déconseillé et non pris en charge actuellement.

Valeur de retour

Cette fonction retourne le type de données JET_ERR avec l’un des codes de retour suivants. Pour plus d’informations sur les erreurs ESE possibles, consultez Les erreurs du moteur de stockage extensible et les paramètres de gestion des erreurs.

Code de retour

Description

JET_errSuccess

L’opération s’est terminée avec succès.

JET_errBufferTooSmall

La taille de la mémoire tampon donnée dans cbMax était trop petite pour contenir les informations souhaitées.

JET_errInvalidName

Un nom non valide a été donné dans szObjectName ou szContainerName.

JET_errInvalidParameter

Un paramètre incorrect a été donné. Il est possible qu’un niveau incorrect ait été transmis à InfoLevel.

Remarques

Si JetGetObjectInfo crée une table temporaire (par exemple, JET_ObjInfoList ou JET_ObjInfoNoStats), l’appelant est chargé de fermer la table temporaire avec JetCloseTable.

JetGetObjectInfo prend actuellement uniquement en charge la récupération d’informations sur les tables.

Spécifications

Besoin Valeur

Client

Nécessite Windows Vista, Windows XP ou Windows 2000 Professionnel.

Serveur

Nécessite Windows Server 2008, Windows Server 2003 ou Windows 2000 Server.

En-tête

Déclaré dans Esent.h.

Bibliothèque

Utilisez ESENT.lib.

DLL

Nécessite ESENT.dll.

Unicode

Implémenté en tant que JetGetObjectInfoW (Unicode) et JetGetObjectInfoA (ANSI).

Voir aussi

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable
JetGetTableInfo

  • Last updated on