Метод IVssCreateExpressWriterMetadata::AddComponent (vswriter.h)

Статья
08/27/2023

Добавляет группу файлов в набор компонентов экспресс-записи для резервного копирования.

Синтаксис

HRESULT AddComponent(
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszCaption,
  [in] const BYTE         *pbIcon,
  [in] UINT               cbIcon,
  [in] bool               bRestoreMetadata,
  [in] bool               bNotifyOnBackupComplete,
  [in] bool               bSelectable,
  [in] bool               bSelectableForRestore,
  [in] DWORD              dwComponentFlags
);

Параметры

[in] ct

Значение перечисления VSS_COMPONENT_TYPE , указывающее тип компонента. Для этого параметра поддерживается только VSS_CT_FILEGROUP .

[in] wszLogicalPath

Указатель на строку расширенных символов, завершающуюся null, которая содержит логический путь к базе данных или файловой группе. Дополнительные сведения см. в разделе Логический путь к компонентам.

Этот параметр является необязательным и может иметь значение NULL.

[in] wszComponentName

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

Этот параметр является обязательным и не может иметь значение NULL. Строка не может содержать обратную косую черту.

[in] wszCaption

Указатель на строку расширенных символов, завершающуюся значением NULL, содержащую описание (также называемое "понятным именем") для компонента. Эта строка может быть локализована, поэтому инициаторы запроса должны предполагать, что она локализована.

Этот параметр является необязательным и может иметь значение NULL. Строка может содержать обратные косые черти.

[in] pbIcon

Указатель на растровое изображение значка, представляющего базу данных, которая будет отображаться в пользовательском интерфейсе. Размер буфера в байтах определяется параметром cbIcon .

Этот параметр является необязательным и может иметь значение NULL.

[in] cbIcon

Размер (в байтах) буфера. Если параметр pbIcon имеет значение NULL, cbIcon должен быть равен нулю.

[in] bRestoreMetadata

Этот параметр зарезервирован для использования в будущем и всегда должен иметь значение false.

[in] bNotifyOnBackupComplete

Этот параметр зарезервирован для использования в будущем и всегда должен иметь значение false.

[in] bSelectable

Логическое значение, указывающее, можно ли дополнительно создать резервную копию компонента (это означает, что его можно исключить из резервной копии) или всегда создавать резервную копию при резервном копировании каких-либо компонентов модуля записи. Этот параметр должен иметь значение
Значение true , если компонент может быть выборочно резервное копирование, или false , если компонент резервное копирование выполняется при резервном копировании любого из компонентов.

[in] bSelectableForRestore

Логическое значение, определяющее, можно ли восстановить компонент по отдельности, если он не был явно включен в документ резервной копии. Если компонент был явно добавлен в документ резервной копии, его всегда можно выбрать по отдельности для восстановления; в данном случае этот флаг не имеет значения.

Если этот параметр имеет значение true, компонент может быть восстановлен сам по себе; При значении false компонент можно восстановить только в том случае, если восстанавливается весь набор компонентов. (Дополнительные сведения см. в разделах VSS_COMPONENTINFO и Работа с возможностью выбора и логическими путями.)

Значение по умолчанию для этого параметра — false.

[in] dwComponentFlags

Битовая маска VSS_COMPONENT_FLAGS значений перечисления, указывающих функции, поддерживаемые этим компонентом. Эта битовая маска не может включать VSS_CF_APP_ROLLBACK_RECOVERY или VSS_CF_BACKUP_RECOVERY.

Значение по умолчанию для этого параметра равно нулю.

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

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

Значение	Значение
S_OK	Операция выполнена успешно.
E_INVALIDARG	Одно из значений параметра недопустимо.
E_OUTOFMEMORY	У вызывающего объекта не хватает памяти или других системных ресурсов.
VSS_E_INVALID_XML_DOCUMENT	Недопустимый XML-документ. Дополнительные сведения см. в журнале событий. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.
VSS_E_OBJECT_ALREADY_EXISTS	Объект является дубликатом. Компонент с таким же логическим путем и именем компонента уже существует.
VSS_E_UNEXPECTED	Непредвиденная ошибка. Код ошибки записывается в файл журнала ошибок. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS. Windows Server 2008, Windows Vista, Windows Server 2003 и Windows XP: Это значение не поддерживается до Windows Server 2008 R2 и Windows 7. вместо этого используется E_UNEXPECTED.

Сочетание логического пути и имени для каждого компонента указанного экземпляра указанного класса модуля записи должно быть уникальным. Попытка вызвать AddComponent дважды с одинаковыми значениями wszLogicalPath и wszComponentName приводит к VSS_E_OBJECT_ALREADY_EXISTS ошибке.

AddComponent можно использовать для добавления подкомпонентов — компонентов, в которых резервные копии всех файлов-членов создаются как группа, но содержат файлы, которые можно восстановить по отдельности. Дополнительные сведения см. в разделе Работа с возможностью выбора для восстановления и подкомпонентов.

Требования


Минимальная версия клиента	Windows 7 [только классические приложения]
Минимальная версия сервера	Windows Server 2008 R2 [только классические приложения]
Целевая платформа	Windows
Header	vswriter.h (включая Vss.h, VsWriter.h)
Библиотека	VssApi.lib

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

IVssCreateExpressWriterMetadata

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