Partager via

Fonction JetOSSnapshotPrepareInstance

  • Article

S’applique à : Windows | Windows Server

Fonction JetOSSnapshotPrepareInstance

La fonction JetOSSnapshotPrepareInstance sélectionne un instance spécifique pour faire partie de la session instantané.

Windows Vista:JetOSSnapshotPrepareInstance a été introduit dans Windows Vista.

JET_ERR JET_API JetOSSnapshotPrepareInstance(
  __in          JET_OSSNAPID snapId,
  __in          JET_INSTANCE instance,
  __in          const JET_GRBIT grbit
);

Paramètres

snapId

Identificateur de la session instantané.

instance

Le instance qui sera utilisé pour cet appel.

grbit

Options de cet appel. Ce paramètre est réservé à un usage futur. La seule valeur valide est 0 (zéro).

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

Le pointeur d’id instantané a la valeur NULL ou le paramètre grbit n’est pas valide.

JET_errOSSnapshotInvalidSequence

Une session instantané est déjà en cours.

JET_errOSSnapshotInvalidSnapId

L’identificateur de la session instantané n’est pas valide.

Si cette fonction réussit, le instance spécifié fera partie de la session instantané.

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

Notes

L’appel de séquence d’API normal est : JetOSSnapshotPrepare, éventuellement suivi d’un ou plusieurs appels à JetOSSnapshotPrepareInstance, puis suivi 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 instantané peut être arrêtée brusquement avec JetOSSnapshotAbort. Les entrées du journal des événements seront générées pour les différentes étapes du instantané.

Si JetOSSnapshotPrepareInstance n’est pas appelé entre le début de la session (JetOSSnapshotPrepare) et le moment de gel (JetOSSnapshotFreeze), toutes les instances en cours d’exécution dans le moteur se figent et font partie de la session instantané. Cela se produit pour deux raisons :

  • Il simplifie le code pour les utilisateurs qui souhaitent toutes les instances.

  • Il permet la compatibilité descendante pour les appelants des API instantané.

Spécifications

Condition requise Valeur

Client

Nécessite Windows Vista.

Serveur

Nécessite Windows Server 2008.

En-tête

Déclaré dans Esent.h.

Bibliothèque

Utilisez ESENT.lib.

DLL

Nécessite ESENT.dll.

Voir aussi

Paramètres de gestion des erreurs
Erreurs du moteur de stockage extensible
JET_ERR
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw