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

Статья
08/27/2023

Метод GetSnapshotProperties получает свойства указанной теневой копии.

Синтаксис

HRESULT GetSnapshotProperties(
  [in]  VSS_ID            SnapshotId,
  [out] VSS_SNAPSHOT_PROP *pProp
);

Параметры

[in] SnapshotId

Идентификатор теневой копии тома, возвращаемого IVssBackupComponents::AddToSnapshotSet.

[out] pProp

Адрес структуры, выделенной вызывающей VSS_SNAPSHOT_PROP , которая получает свойства теневого копирования. Поставщик программного обеспечения отвечает за настройку элементов этой структуры. Поставщик программного обеспечения выделяет память для всех строковых элементов, которые он задает в структуре. Если структура больше не нужна, поставщик программного обеспечения отвечает за освобождение этих строк путем вызова функции VssFreeSnapshotProperties .

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

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

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

Требования


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