Función JetGetDatabaseFileInfo

Se aplica a: Windows | Windows Server

Función JetGetDatabaseFileInfo

La función JetGetDatabaseFileInfo recupera varios tipos de información sobre la base de datos. Se puede llamar a esta API mientras se adjunta o en línea una base de datos (con JetGetDatabaseInfo) o mientras la base de datos o el motor de base de datos está sin conexión (con JetGetDatabaseFileInfo).

    JET_ERR JET_API JetGetDatabaseFileInfo(
      __in          const tchar* szDatabaseName,
      __out         void* pvResult,
      __in          unsigned long cbMax,
      __in          unsigned long InfoLevel
    );

Parámetros

szDatabaseName

Ruta de acceso de la base de datos desde la que se va a recuperar la información.

pvResult

Puntero a un búfer que recibirá la información especificada. El tamaño del búfer, en bytes, se pasa en cbMax.

Si se produce un error en esta función, 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

InfoLevel especifica qué tipo de información se debe recuperar sobre la base de datos especificada. Afecta a cómo se interpreta pvResult . Algunos objetos InfoLevel solo están disponibles en la versión sin conexión (JetGetDatabaseFileInfo) o en línea (JetGetDatabaseInfo) de la API.

Si el búfer pvResult proporcionado es demasiado pequeño, se devolverá JET_errInvalidBufferSize o JET_errBufferTooSmall, dependiendo de InfoLevel.

Value	Significado
JET_DbInfoFilesize	pvResult se interpretará como QWORD (8 bytes). Devuelve el tamaño de la base de datos en bytes.
JET_DbInfoUpgrade	pvResult se interpretará como un JET_DBINFOUPGRADE. La estructura JET_DBINFOUPGRADE se rellenará con información relativa a la base de datos especificada.
JET_DbInfoMisc	pvResult se interpretará como un JET_DBINFOMISC. La estructura JET_DBINFOMISC se rellenará con información relativa a la base de datos especificada.
JET_DbInfoDBInUse	pvResult se interpretará como bool (4 bytes). Esto devolverá si el motor de base de datos tiene actualmente bases de datos abiertas o adjuntas. Windows XP: Este valor se introduce en Windows XP.
JET_DbInfoPageSize	pvResult se interpretará como un long sin signo. Esto devolverá el tamaño de página de la base de datos en bytes. Windows XP: Este valor se introduce en Windows XP.
JET_DbInfoCp	Estos InfoLevels aún no se admiten y devuelven valores predeterminados. No use estos InfoLevels.
JET_DbInfoCountry	Estos InfoLevels aún no se admiten y devuelven valores predeterminados. No use estos InfoLevels.
JET_DbInfoCollate	Igual que JET_DbInfoCp.
JET_DbInfoIsam	Estos InfoLevels están en desuso y no se admiten actualmente. No use estos InfoLevels.
JET_DbInfoConnect	Igual que JET_DbInfoIsam.
JET_DbInfoFileType	Windows Vista: Este valor de InfoLevel se introduce en Windows Vista. pvResult se tratará como un puntero a un DWORD. Devuelve un valor de enumeración, que indica qué tipo de archivo considera que es el motor. Los tipos de archivo se enumeran en la tabla siguiente. Para obtener más información sobre estos tipos de archivos y su uso en el motor, consulte Archivos extensibles del motor de almacenamiento. Value Significado JET_filetypeUnknown El tipo de archivo es desconocido o no es un tipo de archivo ESE. JET_filetypeDatabase El archivo es un archivo de base de datos. JET_filetypeLog El archivo es un archivo de registro de transacciones. JET_filetypeCheckpoint El archivo es un archivo de punto de comprobación. JET_filetypeTempDatabase El archivo es un archivo de base de datos temporal.

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_errFeatureNotAvailable	InfoLevel solicitó JET_DbInfoIsam. Esto no se admite.
JET_errBufferTooSmall	El búfer proporcionado en cbMax es demasiado pequeño para la información deseada.
JET_errInvalidBufferSize	El búfer que se proporciona en cbMax no es el tamaño correcto para la información deseada.
JET_errInvalidParameter	Uno de los parámetros proporcionados contenía un valor inesperado o la combinación de varios valores de parámetro produjo un resultado inesperado. JetGetDatabaseInfo devolverá este error cuando el DBID proporcionado no sea una base de datos válida (adjunta). JetGetDatabaseFileInfo y JetGetDatabaseInfo devolverán este error cuando una infoLevel solicitada no sea compatible con esa versión de la función.

Si esta función se ejecuta correctamente, los datos solicitados se devolverán en el búfer de salida.

Si se produce un error en esta función, el búfer de salida estará en un estado indefinido.

Requisitos

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 JetGetDatabaseFileInfoW (Unicode) y JetGetDatabaseFileInfoA (ANSI).

Consulte también

JET_ERR
JET_DBINFOMISC
JET_DBINFOUPGRADE
JetGetDatabaseInfo