Метод IVssBackupComponentsEx2::SetRestoreName (vsbackup.h)

Назначает новое логическое имя восстанавливаемого компонента.

Синтаксис

HRESULT SetRestoreName(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszRestoreName
);

Параметры

[in] writerId

Глобальный уникальный идентификатор (GUID) класса записи.

[in] ct

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

[in] wszLogicalPath

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

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

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

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

[in] wszComponentName

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

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

[in] wszRestoreName

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

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

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

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

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

Комментарии

Метод SetRestoreName можно вызывать только во время операции восстановления.

Модуль записи указывает, что он поддерживает этот метод, установив флаг VSS_BS_RESTORE_RENAME в маске резервной схемы.

Дополнительные сведения см. в разделе Настройка параметров восстановления VSS.

Требования

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

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

IVssBackupComponentsEx2

IVssComponentEx::GetRestoreName

VSS_BACKUP_SCHEMA