Метод IVssSoftwareSnapshotProvider::GetSnapshotProperties (vsprov.h)

  • Статья

Возвращает свойства указанной теневой копии.

Синтаксис

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

Параметры

[in] SnapshotId

Идентификатор теневого копирования.

[out] pProp

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

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

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

Значение Значение
S_OK
 Запрошенные сведения были успешно возвращены.
E_ACCESSDENIED
 Вызывающий объект не имеет достаточных прав на резервное копирование или не является администратором.
E_INVALIDARG
 Одно из значений параметра является недопустимым.
E_OUTOFMEMORY
 Вызывающий объект не имеет памяти или других системных ресурсов.
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_SNAPSHOT_PROP равным нулю перед вызовом метода GetSnapshotProperties .

Поставщик отвечает за выделение и освобождение строк в структуре VSS_SNAPSHOT_PROP .

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header vsprov.h
Библиотека VssApi.lib

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

IVssSoftwareSnapshotProvider

VssFreeSnapshotProperties