Fonction JetGetTruncateLogInfoInstance

Article
06/13/2023

S’applique à : Windows | Windows Server

Fonction JetGetTruncateLogInfoInstance

La fonction JetGetTruncateLogInfoInstance est utilisée lors d’une sauvegarde lancée par JetBeginExternalBackup pour interroger un instance les noms des fichiers journaux des transactions qui peuvent être supprimés en toute sécurité une fois la sauvegarde terminée.

Windows XP:JetGetTruncateLogInfoInstance est introduit dans Windows XP.

    JET_ERR JET_API JetGetTruncateLogInfoInstance(
      __in          JET_INSTANCE instance,
      __out_opt     tchar* szz,
      __in          unsigned long cbMax,
      __out_opt     unsigned long* pcbActual
    );

Paramètres

instance

Instance à utiliser pour cet appel.

szz

Mémoire tampon de sortie qui reçoit la liste des chaînes terminées par un caractère Null décrivant l’ensemble des fichiers journaux des transactions qui peuvent être supprimés en toute sécurité une fois la sauvegarde terminée.

La liste des chaînes retournées dans cette mémoire tampon est au même format qu’une chaîne multiple utilisée par le Registre. Chaque chaîne terminée par null est retournée dans l’ordre et suivie d’un terminateur Null final.

cbMax

Taille maximale en octets de la mémoire tampon de sortie.

pcbActual

Pointeur vers la mémoire tampon de sortie qui reçoit la quantité réelle de données de chaîne.

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_errInvalidParameter	L’un des paramètres fournis contenait une valeur inattendue ou la combinaison de plusieurs valeurs de paramètre a entraîné un résultat inattendu. Windows XP et versions ultérieures : Cela peut se produire pour JetGetTruncateLogInfoInstance lorsque le handle de instance spécifié n’est pas valide.
JET_errNotInitialized	L’opération ne peut pas se terminer, car le instance associé à la session n’a pas encore été initialisé.
JET_errClientRequestToStopJetService	L’opération ne peut pas se terminer, car toutes les activités sur le instance associée à la session ont cessé à la suite d’un appel à JetStopService.
JET_errInstanceUnavailable	L’opération ne peut pas se terminer, car le instance associé à la session a rencontré une erreur irrécupérable qui exige que l’accès à toutes les données soit révoqué pour protéger l’intégrité de ces données. Windows XP : Cette valeur de retour a été introduite dans Windows XP.
JET_errBackupAbortByServer	L’opération a échoué, car la sauvegarde externe actuelle a été abandonnée par un appel à JetStopBackup. Windows XP : Cette valeur de retour a été introduite dans Windows XP.
JET_errInvalidBackupSequence	L’opération de sauvegarde a échoué, car elle a été appelée hors séquence.
JET_errNoBackup	L’opération a échoué, car aucune sauvegarde externe n’est en cours.
JET_errRestoreInProgress	L’opération ne peut pas se terminer, car une opération de restauration est en cours sur le instance associé à la session.
JET_errTermInProgress	L’opération ne peut pas se terminer, car le instance associé à la session est en cours d’arrêt.
JetGetTruncateLogInfoInstance	Il existe des descripteurs de fichiers en suspens qui ont été créés à l’aide de JetOpenFile pour le instance.

Si cette fonction réussit, les informations demandées sur l’ensemble des fichiers journaux des transactions qui peuvent être supprimés en toute sécurité une fois la sauvegarde terminée sont placées dans les mémoires tampons de sortie où elles sont fournies. La machine d’état de sauvegarde est avancée de telle sorte que la sauvegarde des fichiers de base de données ne soit plus autorisée. Seuls les fichiers correctifs de base de données et les fichiers journaux des transactions peuvent être ouverts pour la sauvegarde au-delà de ce stade.

Si cette fonction échoue, l’état des mémoires tampons de sortie n’est pas défini. L’échec entraîne l’annulation de l’ensemble du processus de sauvegarde pour le instance.

Notes

Cette API ne retourne pas d’erreur ou d’avertissement si la mémoire tampon de sortie est trop petite pour accepter la liste complète des fichiers qui doivent faire partie du jeu de fichiers de sauvegarde. L’application doit toujours fournir une mémoire tampon pour recevoir la taille réelle de cette liste et utiliser ces informations pour déterminer si la liste a été tronquée.

Spécifications

Condition requise	Valeur
Client	Nécessite Windows Vista ou Windows XP.
Serveur	Nécessite Windows Server 2008 ou Windows Server 2003.
En-tête	Déclaré dans Esent.h.
Bibliothèque	Utilisez ESENT.lib.
DLL	Nécessite ESENT.dll.
Unicode	Implémenté en tant que JetGetTruncateLogInfoInstanceW (Unicode) et JetGetTruncateLogInfoInstanceA (ANSI).

Voir aussi

JET_ERR
JET_INSTANCE
JetBeginExternalBackup
JetCloseDatabase
JetCloseTable
JetEndSession
JetOpenFile
JetResetSessionContext
JetRollback
JetStopBackup
JetStopService
JetTerm
JetTerm2

Partager via

Fonction JetGetTruncateLogInfoInstance