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

Возвращает структуру VSS_SNAPSHOT_PROP для snapshot общей папки.

Синтаксис

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.

Комментарии

Перед вызовом метода GetSnapshotProperties вызывающий объект должен задать для содержимого структуры VSS_SNAPSHOT_PROP значение нулю.

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

Координатор VSS вызывает этот метод на этапе PostSnapshot создания snapshot, чтобы получить путь доступа к snapshot (UNC-путь для моментальных снимков файловых ресурсов). Координатор вызывает этот метод после PreFinalCommitSnapshots и перед вызовом PostSnapshot в записи.

Требования

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

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

IVssFileShareSnapshotProvider