Метод IVssComponent::GetBackupMetadata (vswriter.h)

  • Статья

Метод GetBackupMetadata извлекает частные метаданные резервной копии, относящиеся к средству записи, которые могли быть заданы во время события PrepareForBackupcvssWriter::OnPrepareBackup с помощью IVssComponent::SetBackupMetadata.

Только модуль записи может вызывать этот метод.

Синтаксис

HRESULT GetBackupMetadata(
  [out] BSTR *pbstrData
);

Параметры

[out] pbstrData

Адрес переменной, выделенной вызывающим объектом, которая получает строку, содержащую метаданные резервной копии, добавленные во время события OnPrepareBackup .

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

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

Значение Значение
S_OK
 Успешно возвращено значение атрибута.
S_FALSE
 С этим компонентом не связаны метаданные резервного копирования.
E_INVALIDARG
 Одно из значений параметра недопустимо.
E_OUTOFMEMORY
 У вызывающего объекта не хватает памяти или других системных ресурсов.
VSS_E_INVALID_XML_DOCUMENT
 Недопустимый XML-документ. Дополнительные сведения см. в журнале событий. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.

Комментарии

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

Если метаданные резервной копии не заданы, GetBackupMetadata возвращает S_FALSE.

Если вызов GetBackupMetadata выполнен успешно, вызывающий объект отвечает за освобождение строки, возвращаемой в параметре pbstrMetadata , путем вызова функции SysFreeString .

Требования

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

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

IVssComponent

IVssComponent::SetBackupMetadata