Fonction JetGetDatabaseFileInfo
S’applique à : Windows | Windows Server
Fonction JetGetDatabaseFileInfo
La fonction JetGetDatabaseFileInfo récupère différents types d’informations sur la base de données. Cette API peut être appelée lorsqu’une base de données est attachée ou en ligne (avec JetGetDatabaseInfo) ou lorsque la base de données ou le moteur de base de données est hors connexion (avec JetGetDatabaseFileInfo).
JET_ERR JET_API JetGetDatabaseFileInfo(
__in const tchar* szDatabaseName,
__out void* pvResult,
__in unsigned long cbMax,
__in unsigned long InfoLevel
);
Paramètres
szDatabaseName
Chemin d’accès de la base de données à partir de laquelle récupérer les informations.
pvResult
Pointeur vers une mémoire tampon qui recevra les informations spécifiées. La taille de la mémoire tampon, en octets, est passée en cbMax.
Si cette fonction échoue, 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 dans pvResult.
InfoLevel
InfoLevel spécifie le type d’informations à récupérer sur la base de données spécifiée. Cela affecte la façon dont pvResult est interprété. Certains objets InfoLevel sont disponibles uniquement dans la version hors connexion (JetGetDatabaseFileInfo) ou en ligne (JetGetDatabaseInfo) de l’API.
Si la mémoire tampon pvResult fournie est trop petite, JET_errInvalidBufferSize ou JET_errBufferTooSmall sont retournés, selon infoLevel.
Valeur |
Signification |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
JET_DbInfoFilesize |
pvResult sera interprété comme un QWORD (8 octets). Retourne la taille de la base de données en octets. |
||||||||||||
JET_DbInfoUpgrade |
pvResult sera interprété comme un JET_DBINFOUPGRADE. La structure JET_DBINFOUPGRADE est remplie avec des informations relatives à la base de données spécifiée. |
||||||||||||
JET_DbInfoMisc |
pvResult sera interprété comme un JET_DBINFOMISC. La structure JET_DBINFOMISC est remplie avec des informations relatives à la base de données spécifiée. |
||||||||||||
JET_DbInfoDBInUse |
pvResult sera interprété comme un BOOL (4 octets). Cette opération retourne si le moteur de base de données a actuellement des bases de données ouvertes ou attachées. Windows XP : Cette valeur est introduite dans Windows XP. |
||||||||||||
JET_DbInfoPageSize |
pvResult sera interprété comme un long non signé. Cette opération retourne la taille de page de la base de données en octets. Windows XP : Cette valeur est introduite dans Windows XP. |
||||||||||||
JET_DbInfoCp |
Ces InfoLevels ne sont pas encore pris en charge et retournent des valeurs par défaut. N’utilisez pas ces InfoLevels. |
||||||||||||
JET_DbInfoCountry |
Ces InfoLevels ne sont pas encore pris en charge et retournent des valeurs par défaut. N’utilisez pas ces InfoLevels. |
||||||||||||
JET_DbInfoCollate |
Identique à JET_DbInfoCp. |
||||||||||||
JET_DbInfoIsam |
Ces InfoLevels sont déconseillés et ne sont actuellement pas pris en charge. N’utilisez pas ces InfoLevels. |
||||||||||||
JET_DbInfoConnect |
Identique à JET_DbInfoIsam. |
||||||||||||
JET_DbInfoFileType |
Windows Vista : Cette valeur InfoLevel est introduite dans Windows Vista. pvResult sera traité comme un pointeur vers un DWORD. Retourne une valeur d’énumération, indiquant le type de fichier que le moteur considère comme étant. Les types de fichiers sont répertoriés dans le tableau suivant. Pour plus d’informations sur ces types de fichiers et leur utilisation dans le moteur, consultez Fichiers du moteur de stockage extensible.
|
Valeur renvoyée
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 Erreurs du moteur de stockage extensible et Paramètres de gestion des erreurs.
Code de retour |
Description |
|---|---|
JET_errSuccess |
L’opération s’est terminée avec succès. |
JET_errFeatureNotAvailable |
L’InfoLevel demandé a été JET_DbInfoIsam. Cela n'est pas pris en charge. |
JET_errBufferTooSmall |
La mémoire tampon donnée dans cbMax est trop petite pour les informations souhaitées. |
JET_errInvalidBufferSize |
La mémoire tampon indiquée dans cbMax n’est pas la taille correcte pour les informations souhaitées. |
JET_errInvalidParameter |
L’un des paramètres fournis contenait une valeur inattendue, ou la combinaison de plusieurs valeurs de paramètre a produit un résultat inattendu. Cette erreur est retournée par JetGetDatabaseInfo lorsque le DBID fourni n’est pas une base de données (jointe) valide. Cette erreur est retournée par JetGetDatabaseFileInfo et JetGetDatabaseInfo lorsqu’un InfoLevel demandé n’est pas pris en charge par cette version de la fonction. |
Si cette fonction réussit, les données demandées sont retournées dans la mémoire tampon de sortie.
Si cette fonction échoue, la mémoire tampon de sortie est dans un état non défini.
Spécifications
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 JetGetDatabaseFileInfoW (Unicode) et JetGetDatabaseFileInfoA (ANSI). |