JetOSSnapshotPrepareInstance-Funktion
Gilt für: Windows | Windows Server
JetOSSnapshotPrepareInstance-Funktion
Die JetOSSnapshotPrepareInstance-Funktion wählt eine bestimmte Instanz als Teil der Momentaufnahmesitzung aus.
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 Momentaufnahmesitzung.
Instanz
Die -Instanz, 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 den möglichen ESE-Fehlern finden Sie unter Extensible Storage Engine Errors and Error Handling Parameters.
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 Momentaufnahmesitzung wird bereits ausgeführt. |
JET_errOSSnapshotInvalidSnapId |
Der Bezeichner für die Momentaufnahmesitzung ist ungültig. |
Wenn diese Funktion erfolgreich ausgeführt wird, ist die angegebene Instanz Teil der Momentaufnahmesitzung.
Wenn diese Funktion fehlschlägt, erfolgt keine Änderung des Engine-Zustands.
Hinweise
Der normale API-Sequenzaufruf lautet: JetOSSnapshotPrepare, optional gefolgt von einem oder mehreren Aufrufen von JetOSSnapshotPrepareInstance und dann von JetOSSnapshotFreeze. Sobald das Einfrieren gestartet wurde, kann es mit JetOSSnapshotThawbeendet werden. Die Momentaufnahmesitzung kann jederzeit nach der Vorbereitung mit JetOSSnapshotAbortplötzlich beendet werden. Ereignisprotokolleinträge werden für die verschiedenen Schritte der Momentaufnahme generiert.
Wenn JetOSSnapshotPrepareInstance zwischen dem Start der Sitzung (JetOSSnapshotPrepare) und dem Einfrierensmoment (JetOSSnapshotFreeze)nicht aufgerufen wird, frieren alle ausgeführten Instanzen in der Engine ein und werden Teil der Momentaufnahmesitzung. Dies geschieht aus zwei Gründen:
Es vereinfacht den Code für Benutzer, die alle Instanzen benötigen.
Sie ermöglicht Abwärtskompatibilität für die Aufrufer der Momentaufnahme-APIs.
Anforderungen
| Anforderung | Wert |
|---|---|
Client |
Erfordert Windows Vista. |
Server |
Erfordert Windows Server 2008. |
Header |
Deklariert in Esent.h. |
Bibliothek |
Verwenden Sie ESENT.lib. |
DLL |
Erfordert ESENT.dll. |
Weitere Informationen
Fehlerbehandlungsparameter
Erweiterbare Storage-Engine-Fehler
JET_ERR
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw