Поделиться через

Метод IVssBackupComponents::SetBackupOptions (vsbackup.h)

  • Статья

Метод SetBackupOptions задает строку частных параметров резервного копирования или зависимых от записи параметров резервного копирования для компонента.

Синтаксис

HRESULT SetBackupOptions(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszBackupOptions
);

Параметры

[in] writerId

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

[in] ct

Тип компонента. Возможные значения см. в VSS_COMPONENT_TYPE .

[in] wszLogicalPath

Строка расширенных символов со значением NULL, содержащая логический путь к компоненту.

Дополнительные сведения см. в разделе Логический путь компонентов.

Значение строки, содержащей используемый здесь логический путь, должно совпадать с значением, которое использовалось при добавлении компонента в резервный набор с помощью IVssBackupComponents::AddComponent.

Логический путь может иметь значение NULL.

Нет ограничений на символы, которые могут отображаться в логическом пути, отличном от NULL .

[in] wszComponentName

Строка расширенных символов со значением NULL, содержащая имя компонента.

Строка, содержащая имя, не может иметь значение NULL и должна содержать то же имя компонента, которое использовалось при добавлении компонента в резервный набор с помощью IVssBackupComponents::AddComponent.

[in] wszBackupOptions

Строка расширенных символов со значением NULL, содержащая заданные параметры резервной копии.

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

Ниже приведены допустимые коды возврата для этого метода.

Значение Значение
S_OK
 Параметры резервного копирования успешно настроены.
E_INVALIDARG
 Одно из значений параметра является недопустимым.
E_OUTOFMEMORY
 Вызывающий объект не имеет памяти или других системных ресурсов.
VSS_E_BAD_STATE
 Объект компонента резервной копии не инициализирован, этот метод был вызван во время операции восстановления или этот метод не был вызван в правильной последовательности.
VSS_E_OBJECT_NOT_FOUND
 Компонент резервного копирования не существует.
VSS_E_INVALID_XML_DOCUMENT
 Недопустимый XML-документ. Дополнительные сведения см. в журнале событий. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.
VSS_E_UNEXPECTED
 Непредвиденная ошибка. Код ошибки регистрируется в файле журнала ошибок. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.

Windows Server 2008, Windows Vista, Windows Server 2003 и Windows XP: Это значение не поддерживается до Windows Server 2008 R2 и Windows 7. вместо этого используется E_UNEXPECTED.

Комментарии

Точный синтаксис и содержимое параметров резервного копирования, заданных параметром wszBackupOptions метода SetBackupOptions , будут зависеть от конкретного модуля записи, с которым осуществляется контакт.

Этот метод необходимо вызывать перед IVssBackupComponents::P repareForBackup.

Требования

Требование Значение
Минимальная версия клиента Windows XP [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header vsbackup.h (включая VsBackup.h, Vss.h, VsWriter.h)
Библиотека VssApi.lib

См. также раздел

IVssBackupComponents

IVssBackupComponents::P repareForBackup

IVssBackupComponents::SetRestoreOptions

VSS_COMPONENT_TYPE