JetGetDatabaseFileInfo-Funktion
Gilt für: Windows | Windows Server
JetGetDatabaseFileInfo-Funktion
Die JetGetDatabaseFileInfo-Funktion ruft verschiedene Arten von Informationen über die Datenbank ab. Diese API kann aufgerufen werden, während eine Datenbank angefügt oder online (mit JetGetDatabaseInfo) oder während die Datenbank oder Datenbank-Engine offline ist (mit JetGetDatabaseFileInfo).
JET_ERR JET_API JetGetDatabaseFileInfo(
__in const tchar* szDatabaseName,
__out void* pvResult,
__in unsigned long cbMax,
__in unsigned long InfoLevel
);
Parameter
szDatabaseName
Der Pfad der Datenbank, aus der die Informationen abgerufen werden sollen.
pvResult
Zeiger auf einen Puffer, der die angegebenen Informationen empfängt. Die Größe des Puffers in Bytes wird in cbMax übergeben.
Wenn diese Funktion fehlschlägt, ist der Inhalt von pvResult undefiniert.
Die in pvResult gespeicherten Informationen hängen von InfoLevel ab.
cbMax
Die Größe des in pvResult übergebenen Puffers in Bytes.
InfoLevel
InfoLevel gibt an, welcher Informationstyp über die angegebene Datenbank abgerufen werden soll. Dies wirkt sich darauf aus, wie pvResult interpretiert wird. Einige InfoLevel-Objekte sind nur in der Offlineversion (JetGetDatabaseFileInfo) oder online (JetGetDatabaseInfo) der API verfügbar.
Wenn der bereitgestellte pvResult-Puffer zu klein ist, wird je nach InfoLevel entweder JET_errInvalidBufferSize oder JET_errBufferTooSmall zurückgegeben.
Wert |
Bedeutung |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
JET_DbInfoFilesize |
pvResult wird als QWORD (8 Bytes) interpretiert. Gibt die Größe der Datenbank in Bytes zurück. |
||||||||||||
JET_DbInfoUpgrade |
pvResult wird als JET_DBINFOUPGRADE interpretiert. Die JET_DBINFOUPGRADE-Struktur wird mit Informationen zur angegebenen Datenbank aufgefüllt. |
||||||||||||
JET_DbInfoMisc |
pvResult wird als JET_DBINFOMISC interpretiert. Die JET_DBINFOMISC-Struktur wird mit Informationen zur angegebenen Datenbank aufgefüllt. |
||||||||||||
JET_DbInfoDBInUse |
pvResult wird als BOOL (4 Bytes) interpretiert. Dadurch wird zurückgegeben, ob die Datenbank-Engine derzeit über offene oder angefügte Datenbanken verfügt. Windows XP: Dieser Wert wird in Windows XP eingeführt. |
||||||||||||
JET_DbInfoPageSize |
pvResult wird als nicht signierter Long-Wert interpretiert. Dadurch wird die Seitengröße der Datenbank in Bytes zurückgegeben. Windows XP: Dieser Wert wird in Windows XP eingeführt. |
||||||||||||
JET_DbInfoCp |
Diese InfoLevels werden noch nicht unterstützt und geben Standardwerte zurück. Verwenden Sie diese InfoLevels nicht. |
||||||||||||
JET_DbInfoCountry |
Diese InfoLevels werden noch nicht unterstützt und geben Standardwerte zurück. Verwenden Sie diese InfoLevels nicht. |
||||||||||||
JET_DbInfoCollate |
Identisch mit JET_DbInfoCp. |
||||||||||||
JET_DbInfoIsam |
Diese InfoLevels sind veraltet und werden derzeit nicht unterstützt. Verwenden Sie diese InfoLevels nicht. |
||||||||||||
JET_DbInfoConnect |
Identisch mit JET_DbInfoIsam. |
||||||||||||
JET_DbInfoFileType |
Windows Vista: Dieser InfoLevel-Wert wird in Windows Vista eingeführt. pvResult wird als Zeiger auf ein DWORD behandelt. Gibt einen Enumerationswert zurück, der angibt, welche Art von Datei die Engine als diese betrachtet. Dateitypen werden in der folgenden Tabelle aufgeführt. Weitere Informationen zu diesen Dateitypen und deren Verwendung für die Engine finden Sie unter Erweiterbare Speichermoduldateien.
|
Rückgabewert
Diese Funktion gibt den JET_ERR-Datentyp mit einem der folgenden Rückgabecodes zurück. Weitere Informationen zu möglichen ESE-Fehlern finden Sie unter Erweiterbare Speichermodulfehler und Fehlerbehandlungsparameter.
Rückgabecode |
Beschreibung |
|---|---|
JET_errSuccess |
Der Vorgang wurde erfolgreich abgeschlossen. |
JET_errFeatureNotAvailable |
Der angeforderte InfoLevel wurde JET_DbInfoIsam. Dieser Vorgang wird nicht unterstützt. |
JET_errBufferTooSmall |
Der Puffer, der in cbMax angegeben wird, ist zu klein für die gewünschten Informationen. |
JET_errInvalidBufferSize |
Der puffer, der in cbMax angegeben ist, ist nicht die richtige Größe für die gewünschten Informationen. |
JET_errInvalidParameter |
Einer der bereitgestellten Parameter enthielt einen unerwarteten Wert, oder die Kombination mehrerer Parameterwerte ergab ein unerwartetes Ergebnis. Dieser Fehler wird von JetGetDatabaseInfo zurückgegeben, wenn die bereitgestellte DBID keine gültige (angefügte) Datenbank ist. Dieser Fehler wird von JetGetDatabaseFileInfo und JetGetDatabaseInfo zurückgegeben, wenn ein angeforderter InfoLevel von dieser Version der Funktion nicht unterstützt wird. |
Wenn diese Funktion erfolgreich ist, werden die angeforderten Daten im Ausgabepuffer zurückgegeben.
Wenn diese Funktion fehlschlägt, befindet sich der Ausgabepuffer in einem nicht definierten Zustand.
Anforderungen
Client |
Erfordert Windows Vista, Windows XP oder Windows 2000 Professional. |
Server |
Erfordert Windows Server 2008, Windows Server 2003 oder Windows 2000 Server. |
Kopfzeile |
Deklariert in Esent.h. |
Bibliothek |
Verwenden Sie ESENT.lib. |
DLL |
Erfordert ESENT.dll. |
Unicode |
Implementiert als JetGetDatabaseFileInfoW (Unicode) und JetGetDatabaseFileInfoA (ANSI). |