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

Удаляет одну или несколько теневых копий или набор теневого копирования.

Синтаксис

HRESULT DeleteSnapshots(
  [in]  VSS_ID          SourceObjectId,
  [in]  VSS_OBJECT_TYPE eSourceObjectType,
  [in]  BOOL            bForceDelete,
  [out] LONG            *plDeletedSnapshots,
  [out] VSS_ID          *pNondeletedSnapshotID
);

Параметры

[in] SourceObjectId

Идентификатор теневой копии или набора теневого копирования, который требуется удалить.

[in] eSourceObjectType

Тип удаляемого объекта. Этот параметр имеет значение VSS_OBJECT_SNAPSHOT или VSS_OBJECT_SNAPSHOT_SET.

[in] bForceDelete

Если этот параметр имеет значение TRUE, поставщик сделает все возможное, чтобы удалить теневую копию или теневые копии в наборе теневого копирования. Если он имеет значение FALSE, никаких дополнительных усилий не будет предпринят.

[out] plDeletedSnapshots

Указатель на переменную, получающую количество удаленных теневых копий.

[out] pNondeletedSnapshotID

При возникновении ошибки этот параметр получает указатель на идентификатор первой теневой копии, которую не удалось удалить. В противном случае он указывает на GUID_NULL.

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

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

Значение Значение
S_OK
Теневые копии успешно удалены.
E_ACCESSDENIED
Вызывающий объект не имеет достаточных прав на резервное копирование или не является администратором.
E_INVALIDARG
Одно из значений параметра является недопустимым.
E_OUTOFMEMORY
Вызывающий объект не имеет памяти или других системных ресурсов.
VSS_E_OBJECT_NOT_FOUND
Указанные теневые копии не найдены.
VSS_E_PROVIDER_VETO
Ошибка поставщика. Поставщик зарегистрировал ошибку в журнале событий. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.

Комментарии

Несколько теневых копий в наборе теневого копирования удаляются последовательно. Если во время одного из этих отдельных удалений возникает ошибка, deleteSnapshots возвращается немедленно; Не будет предпринята попытка удалить все оставшиеся теневые копии. VSS_ID отмененной теневой копии возвращается в pNondeletedSnapshotID.

Требования

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

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

IVssSoftwareSnapshotProvider