JetOSSnapshotPrepareInstance-Funktion

  • Artikel

Gilt für: Windows | Windows Server

JetOSSnapshotPrepareInstance-Funktion

Die JetOSSnapshotPrepareInstance-Funktion wählt einen bestimmten instance aus, der Teil der Momentaufnahme-Sitzung sein soll.

Windows Vista:JetOSSnapshotPrepareInstance wurde in Windows Vista eingeführt.

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

Parameter

snapId

Der Bezeichner der Momentaufnahme Sitzung.

instance

Die instance, die für diesen Aufruf verwendet wird.

grbit

Die Optionen für diesen Aufruf. Dieser Parameter ist für die zukünftige Verwendung reserviert. Der einzige gültige Wert ist 0 (null).

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_errInvalidParameter

Der Momentaufnahme-ID-Zeiger ist NULL, oder der grbit-Parameter ist ungültig.

JET_errOSSnapshotInvalidSequence

Eine Momentaufnahme-Sitzung wird bereits ausgeführt.

JET_errOSSnapshotInvalidSnapId

Der Bezeichner für die Momentaufnahme Sitzung ist ungültig.

Wenn diese Funktion erfolgreich ist, ist die angegebene instance Teil der Momentaufnahme-Sitzung.

Wenn diese Funktion fehlschlägt, tritt keine Änderung des Engine-Zustands auf.

Bemerkungen

Der normale API-Sequenzaufruf lautet : JetOSSnapshotPrepare, optional gefolgt von einem oder mehreren Aufrufen von JetOSSnapshotPrepareInstance, gefolgt von JetOSSnapshotFreeze. Sobald das Einfrieren gestartet wurde, kann es mit JetOSSnapshotThaw beendet werden. Die Momentaufnahme-Sitzung kann jederzeit nach der Vorbereitung mit JetOSSnapshotAbort abrupt beendet werden. Ereignisprotokolleinträge werden für die verschiedenen Schritte der Momentaufnahme generiert.

Wenn JetOSSnapshotPrepareInstance zwischen dem Beginn der Sitzung (JetOSSnapshotPrepare) und dem Freeze-Moment (JetOSSnapshotFreeze) nicht aufgerufen wird, werden alle ausgeführten Instanzen in der Engine einfrieren und Teil der Momentaufnahme Sitzung. Dies hat zwei Gründe:

  • Es vereinfacht den Code für Benutzer, die alle Instanzen benötigen.

  • Es ermöglicht abwärtskompatibilität für die Aufrufer der Momentaufnahme-APIs.

Anforderungen

Anforderung Wert

Client

Erfordert Windows Vista.

Server

Erfordert Windows Server 2008.

Kopfzeile

Deklariert in Esent.h.

Bibliothek

Verwenden Sie ESENT.lib.

DLL

Erfordert ESENT.dll.

Weitere Informationen

Fehlerbehandlungsparameter
Erweiterbare Speicher-Engine-Fehler
JET_ERR
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw