Fonction JetOSSnapshotPrepare

Article
12/19/2023

S’applique à : Windows | Windows Server

Fonction JetOSSnapshotPrepare

La fonction JetOSSnapshotPrepare commence les préparations d’une session d’instantané. Une session d’instantané est un intervalle de temps court au cours duquel le moteur n’émet pas d’E/S d’écriture sur le disque. Le moteur peut donc participer à une session de cliché instantané de volume (lorsqu’il est piloté par un enregistreur d’instantané).

Windows XP :JetOSSnapshotPrepare est introduit dans Windows XP.

    JET_ERR JET_API JetOSSnapshotPrepare(
      __out         JET_OSSNAPID* psnapId,
      __in          const JET_GRBIT grbit
    );

Paramètres

psnapId

Identificateur de la session d’instantané à démarrer.

grbit

Options de cet appel. Ce paramètre peut être une combinaison des valeurs suivantes.

Valeur	Signification
0	Instantané normal.
JET_bitIncrementalSnapshot	Seuls les fichiers journaux sont pris.
JET_bitCopySnapshot	Copie instantanée (normale ou incrémentielle) sans troncation de journal.
JET_bitContinueAfterThaw	La session d’instantané a lieu après JetOSSnapshotThaw et nécessite un appel de fonction JetOSSnapshotEnd.
JET_bitExplicitPrepare	Aucune instance n’est préparée par défaut. Windows 7 : JET_bitExplicitPrepare est introduit dans Windows 7.

Valeur de retour

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 les articles 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	Le pointeur d’ID d’instantané est NULL ou le paramètre grbit n’est pas valide.
JET_errOSSnapshotInvalidSequence	Une session d’instantané est déjà en cours et l’opération n’est pas autorisée à avoir plusieurs sessions d’instantané à un moment donné.

Si cette fonction réussit, une session d’instantané peut commencer à tout moment avec la phase de gel des E/S. L’identificateur de la session est retourné et doit être utilisé dans les appels suivants pour la session d’instantané.

Les instances en cours d’exécution du moteur sont désormais considérées comme faisant partie de la session d’instantané.

Windows Vista : pour spécifier un sous-ensemble différent d’instances, la fonction JetOSSnapshotPrepareInstance peut être appelée.

L’appel de séquence d’API normal est : JetOSSnapshotPrepare, éventuellement suivi d’un ou plusieurs appels à la fonction JetOSSnapshotPrepareInstance, puis de JetOSSnapshotFreeze. Une fois le gel démarré, il peut être arrêté à l’aide de JetOSSnapshotThaw. À tout moment après la préparation, la session d’instantané peut être brusquement arrêtée avec JetOSSnapshotAbort.

Si la fonction JET_bitContinueAfterThaw est spécifiée après JetOSSnapshotThaw, la session d’instantané reste (bien que l’E/S reprenne). Cela permet de vérifier l’instantané et, si nécessaire, de tronquer le journal à l’aide de JetOSSnapshotTruncateLog et cela nécessite un appel à JetOSSnapshotEnd.

Si cette fonction échoue, aucune modification de l’état du moteur ne se produit.

Notes

Les entrées du journal des événements sont générées pour les différentes étapes de l’instantané.

Configuration requise

Condition requise	Value
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	Utilise ESENT.lib.
DLL	Nécessite ESENT.dll.

Voir aussi

JET_ERR
JET_OSSNAPID
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepareInstance
JetOSSnapshotThaw
JetOSSnapshotTruncateLog

Partager via

Fonction JetOSSnapshotPrepare