Función JetGetObjectInfo

Artículo
06/13/2023

Se aplica a: Windows | Windows Server

Función JetGetObjectInfo

La función JetGetObjectInfo recupera información sobre los objetos de base de datos. Actualmente, solo se admiten tablas. JetGetTableInfo se puede usar para capturar más información 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
    );

Parámetros

sesid

Contexto de sesión de base de datos que se va a usar.

dbid

Base de datos de la que se recupera la información.

objtyp

Objetos que contienen información que se va a recuperar. Actualmente, solo se admiten JET_objtypNil y JET_objtypTable, ambos se comportan de forma idéntica. Solo se recuperarán las tablas.

szContainerName

Este parámetro está reservado para uso futuro y pasa NULL. Nombre de los tipos de objetos sobre los que se va a recuperar información.

szObjectName

Nombre del objeto que contiene información que se va a recuperar. Cuando InfoLevel usa las opciones JET_ObjInfoList o JET_ObjInfoListNoStats para recuperar una lista de todos los objetos, este valor debe ser NULL o una cadena vacía.

Actualmente solo se admiten nombres de tabla.

pvResult

Puntero a un búfer que recibe la información especificada.

El tamaño del búfer, en bytes, se pasa en cbMax. Si se produce un error, el contenido de pvResult no está definido.

La información almacenada en pvResult depende de InfoLevel.

cbMax

Tamaño, en bytes, del búfer pasado en pvResult.

InfoLevel

Especifica el tipo de información que se va a recuperar para el objeto especificado. Afecta a cómo se interpreta pvResult .

Las siguientes opciones están disponibles para establecer para este parámetro.

Valor	Significado
JET_ObjInfo	pvResult se interpreta como una estructura JET_OBJECTINFO . La estructura JET_OBJECTINFO se rellena con información relativa al objeto denominado en szObjectName. Si el autor de la llamada no desea conocer el número de registros y páginas del objeto, considere la posibilidad de usar JET_ObjInfoNoStats nivel de información, lo que podría ser más rápido, ya que no se incluyen estadísticas.
JET_ObjInfoList	pvResult se interpreta como una estructura de JET_OBJECTLIST . Se recupera información sobre todos los objetos. Se creará una tabla temporal y la información necesaria para recorrer la tabla temporal se describe en la estructura JET_OBJECTLIST . Para obtener más información, consulte JET_OBJECTLIST. Si el autor de la llamada no desea conocer el número de registros y páginas del objeto, considere la posibilidad de usar JET_ObjInfoListNoStats, lo que podría ser más rápido.
JET_ObjInfoListACM	En desuso y no se admite actualmente.
JET_ObjInfoListNoStats	pvResult se interpreta como una estructura de JET_OBJECTLIST . Se recupera información sobre todos los objetos. Se creará una tabla temporal y la información necesaria para recorrer la tabla temporal se describe en la estructura JET_OBJECTLIST . Para obtener más información, consulte JET_OBJECTLIST. JET_ObjInfoListNoStats es idéntico a JET_ObjInfoList, salvo que las columnas que notifican el número de registros (columnidcRecord) y las páginas (columnidcPage) no se actualizarán.
JET_ObjInfoMax	pvResult se interpreta como un JET_OBJECTINFO. El tamaño máximo del objeto está en páginas. Actualmente solo se devolverán las tablas.
JET_ObjInfoNoStats	pvResult se interpreta como un JET_OBJECTINFO. Solo se recuperará información sobre el objeto especificado en szObjectName . La estructura JET_OBJECTINFO se rellenará con información relativa al objeto denominado en szObjectName. JET_ObjInfoNoStats es idéntico a JET_ObjInfo, salvo que los campos que notifican el número de registros y páginas se establecen en cero.
JET_ObjInfoRulesLoaded	En desuso y no se admite actualmente.
JET_ObjInfoSysTabCursor	En desuso y no se admite actualmente.
JET_ObjInfoSysTabReadOnly	En desuso y no se admite actualmente.

Valor devuelto

Esta función devuelve el JET_ERR tipo de datos con uno de los siguientes códigos de retorno. Para obtener más información sobre los posibles errores de ESE, vea Extensible Storage Engine Errors and Error Handling Parameters.

Código devuelto	Descripción
JET_errSuccess	La operación se ha completado correctamente.
JET_errBufferTooSmall	El tamaño del búfer proporcionado en cbMax era demasiado pequeño para contener la información deseada.
JET_errInvalidName	Se ha proporcionado un nombre no válido en szObjectName o szContainerName.
JET_errInvalidParameter	Se ha proporcionado un parámetro incorrecto. Es posible que se pase un nivel incorrecto a InfoLevel.

Observaciones

Si JetGetObjectInfo crea correctamente una tabla temporal (por ejemplo, JET_ObjInfoList o JET_ObjInfoNoStats), el autor de la llamada es responsable de cerrar la tabla temporal con JetCloseTable.

JetGetObjectInfo actualmente solo admite la recuperación de información sobre tablas.

Requisitos

Requisito	Value
Cliente	Requiere Windows Vista, Windows XP o Windows 2000 Professional.
Servidor	Requiere Windows Server 2008, Windows Server 2003 o Windows 2000 Server.
Encabezado	Declarado en Esent.h.
Library	Use ESENT.lib.
Archivo DLL	Requiere ESENT.dll.
Unicode	Se implementa como JetGetObjectInfoW (Unicode) y JetGetObjectInfoA (ANSI).

Consulte también

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable
JetGetTableInfo

Función JetGetObjectInfo