Função JetGetDatabaseFileInfo
Aplica-se a: Windows | Windows Server
Função JetGetDatabaseFileInfo
A função JetGetDatabaseFileInfo recupera vários tipos de informações sobre o banco de dados. Essa API pode ser chamada enquanto um banco de dados está anexado ou online (com JetGetDatabaseInfo) ou enquanto o banco de dados ou mecanismo de banco de dados está offline (com JetGetDatabaseFileInfo).
JET_ERR JET_API JetGetDatabaseFileInfo(
__in const tchar* szDatabaseName,
__out void* pvResult,
__in unsigned long cbMax,
__in unsigned long InfoLevel
);
Parâmetros
szDatabaseName
O caminho do banco de dados do qual recuperar as informações.
pvResult
Ponteiro para um buffer que receberá as informações especificadas. O tamanho do buffer, em bytes, é passado em cbMax.
Se essa função falhar, o conteúdo de pvResult será indefinido.
As informações armazenadas em pvResult dependem do InfoLevel.
cbMax
O tamanho, em bytes, do buffer passado em pvResult.
InfoLevel
InfoLevel especifica qual tipo de informação deve ser recuperada sobre o banco de dados especificado. Isso afeta a forma como o pvResult é interpretado. Alguns objetos InfoLevel estão disponíveis apenas na versão offline (JetGetDatabaseFileInfo) ou online (JetGetDatabaseInfo) da API.
Se o buffer pvResult fornecido for muito pequeno, JET_errInvalidBufferSize ou JET_errBufferTooSmall serão retornados, dependendo do InfoLevel.
Valor |
Significado |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
JET_DbInfoFilesize |
pvResult será interpretado como um QWORD (8 bytes). Retorna o tamanho do banco de dados em bytes. |
||||||||||||
JET_DbInfoUpgrade |
pvResult será interpretado como um JET_DBINFOUPGRADE. A estrutura de JET_DBINFOUPGRADE será preenchida com informações relativas ao banco de dados especificado. |
||||||||||||
JET_DbInfoMisc |
pvResult será interpretado como um JET_DBINFOMISC. A estrutura JET_DBINFOMISC será preenchida com informações relativas ao banco de dados especificado. |
||||||||||||
JET_DbInfoDBInUse |
pvResult será interpretado como um BOOL (4 bytes). Isso retornará se o mecanismo de banco de dados atualmente tem bancos de dados abertos ou anexados. Windows XP: Esse valor é introduzido no Windows XP. |
||||||||||||
JET_DbInfoPageSize |
pvResult será interpretado como um long sem sinal. Isso retornará o tamanho da página do banco de dados em bytes. Windows XP: Esse valor é introduzido no Windows XP. |
||||||||||||
JET_DbInfoCp |
Esses InfoLevels ainda não têm suporte e retornam valores padrão. Não use esses InfoLevels. |
||||||||||||
JET_DbInfoCountry |
Esses InfoLevels ainda não têm suporte e retornam valores padrão. Não use esses InfoLevels. |
||||||||||||
JET_DbInfoCollate |
O mesmo que JET_DbInfoCp. |
||||||||||||
JET_DbInfoIsam |
Esses InfoLevels foram preteridos e não têm suporte no momento. Não use esses InfoLevels. |
||||||||||||
JET_DbInfoConnect |
O mesmo que JET_DbInfoIsam. |
||||||||||||
JET_DbInfoFileType |
Windows Vista: Esse valor InfoLevel é introduzido no Windows Vista. pvResult será tratado como um ponteiro para um DWORD. Retorna um valor de enumeração, indicando que tipo de arquivo o mecanismo considera isso. Os tipos de arquivo são listados na tabela a seguir. Para obter mais informações sobre esses tipos de arquivos e seu uso para o mecanismo, consulte Arquivos extensíveis do mecanismo de armazenamento.
|
Valor Retornado
Essa função retorna o tipo de dados JET_ERR com um dos seguintes códigos de retorno. Para obter mais informações sobre os possíveis erros de ESE, consulte Erros extensíveis do mecanismo de armazenamento e parâmetros de tratamento de erros.
Código de retorno |
Descrição |
|---|---|
JET_errSuccess |
A operação foi concluída com sucesso. |
JET_errFeatureNotAvailable |
O InfoLevel solicitado foi JET_DbInfoIsam. Isso não tem suporte. |
JET_errBufferTooSmall |
O buffer fornecido em cbMax é muito pequeno para as informações desejadas. |
JET_errInvalidBufferSize |
O buffer fornecido em cbMax não é o tamanho correto para as informações desejadas. |
JET_errInvalidParameter |
Um dos parâmetros fornecidos continha um valor inesperado ou a combinação de vários valores de parâmetro gerava um resultado inesperado. Esse erro será retornado por JetGetDatabaseInfo quando o DBID fornecido não for um banco de dados válido (anexado). Esse erro será retornado por JetGetDatabaseFileInfo e JetGetDatabaseInfo quando um InfoLevel solicitado não tiver suporte nessa versão da função. |
Se essa função for bem-sucedida, os dados solicitados serão retornados no buffer de saída.
Se essa função falhar, o buffer de saída estará em um estado indefinido.
Requisitos
Cliente |
Requer Windows Vista, Windows XP ou Windows 2000 Professional. |
Servidor |
Requer o Windows Server 2008, o Windows Server 2003 ou o Windows 2000 Server. |
Cabeçalho |
Declarado em Esent.h. |
Biblioteca |
Use ESENT.lib. |
DLL |
Requer ESENT.dll. |
Unicode |
Implementado como JetGetDatabaseFileInfoW (Unicode) e JetGetDatabaseFileInfoA (ANSI). |