Функция JetOSSnapshotPrepareInstance

Применимо к: Windows | Windows Server

Функция JetOSSnapshotPrepareInstance

Функция JetOSSnapshotPrepareInstance выбирает конкретный экземпляр для участия в сеансе snapshot.

Windows Vista:JetOSSnapshotPrepareInstance появилась в Windows Vista.

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

Параметры

snapId

Идентификатор сеанса snapshot.

Экземпляр

Экземпляр, который будет использоваться для этого вызова.

grbit

Параметры для этого вызова. Этот параметр зарезервирован для использования в будущем. Единственное допустимое значение — 0 (ноль).

Возвращаемое значение

Эта функция возвращает тип данных JET_ERR с одним из следующих кодов возврата. Дополнительные сведения о возможных ошибках ESE см. в разделах Ошибки подсистемы расширяемого хранилища и Параметры обработки ошибок.

Код возврата

Описание

JET_errSuccess

Операция выполнена успешно.

JET_errInvalidParameter

Указатель идентификатора snapshot имеет значение NULL или недопустимый параметр grbit.

JET_errOSSnapshotInvalidSequence

Сеанс snapshot уже выполняется.

JET_errOSSnapshotInvalidSnapId

Недопустимый идентификатор сеанса snapshot.

Если эта функция выполняется успешно, указанный экземпляр будет частью сеанса snapshot.

Если эта функция завершается сбоем, изменение состояния подсистемы не происходит.

Комментарии

Обычный вызов последовательности API: JetOSSnapshotPrepare, за которым при необходимости следует один или несколько вызовов JetOSSnapshotPrepareInstance, а затем JetOSSnapshotFreeze. После запуска замораживания его можно завершить с помощью JetOSSnapshotThaw. В любое время после подготовки сеанс snapshot можно внезапно завершить с помощью JetOSSnapshotAbort. Записи журнала событий будут создаваться для различных шагов snapshot.

Если JetOSSnapshotPrepareInstance не вызывается между началом сеанса (JetOSSnapshotPrepare) и моментом заморозки (JetOSSnapshotFreeze), все запущенные экземпляры в подсистеме зависнут и станут частью сеанса snapshot. Это происходит по двум причинам:

  • Это упрощает код для пользователей, которым нужны все экземпляры.

  • Это обеспечивает обратную совместимость для вызывающих snapshot API.

Требования

Требование Значение

Клиент

Требуется Windows Vista.

Сервер

Требуется Windows Server 2008.

Верхняя часть

Объявлено в Esent.h.

Библиотека

Используйте ESENT.lib.

DLL

Требуется ESENT.dll.

См. также:

Параметры обработки ошибок
Ошибки расширяемого обработчика хранилища
JET_ERR
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw