Метод IVssCreateWriterMetadataEx::AddExcludeFilesFromSnapshot (vswriter.h)

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

Вызов этого метода не приводит к исключению файлов. Модуль записи отвечает за удаление файлов из теневой копии в методе CVssWriter::OnPostSnapshot .

Синтаксис

HRESULT AddExcludeFilesFromSnapshot(
  [in] LPCWSTR wszPath,
  [in] LPCWSTR wszFilespec,
  [in] bool    bRecursive
);

Параметры

[in] wszPath

Указатель на строку расширенных символов, завершающуюся значением NULL, содержащую корневой каталог, в котором должны быть исключены файлы.

Каталог может быть локальным каталогом на компьютере VSS или каталогом общей папки на удаленном файловом сервере.

Поддерживаются UNC-пути.

Путь может содержать переменные среды (например, %SystemRoot%), но не может содержать подстановочные знаки.

Не требуется, чтобы путь заканчивалась обратной косой чертой (""). Приложения, извлекающие эти сведения, должны проверка, заканчивается ли путь обратной косой чертой.

[in] wszFilespec

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

Спецификация файла не может содержать спецификации каталога (например, без обратных косых черт), но может содержать ? и * подстановочные знаки.

[in] bRecursive

Логическое значение, указывающее, определяет ли путь, заданный параметром wszPath , только один каталог или указывает иерархию каталогов для рекурсивного просмотра. Этот параметр должен иметь значение true , если путь рассматривается как иерархия каталогов для рекурсии, или false в противном случае.

Сведения о обходе подключенных папок см. в разделах Работа с подключенными папками и Точки повторного анализа.

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

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

Значение Значение
S_OK
0x00000000L
Операция выполнена успешно.
E_INVALIDARG
0x80070057L
Одно из значений параметра недопустимо.
E_OUTOFMEMORY
0x8007000EL
У вызывающего объекта не хватает памяти или других системных ресурсов.
VSS_E_INVALID_XML_DOCUMENT
0x80042311L
Недопустимый XML-документ. Дополнительные сведения см. в журнале событий. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.
VSS_E_NOT_SUPPORTED
0x8004232FL
Этот метод не поддерживается для экспресс-модулей записи.
VSS_E_UNEXPECTED
Непредвиденная ошибка. Код ошибки записывается в файл журнала ошибок. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.

Windows Server 2008, Windows Vista, Windows Server 2003 и Windows XP: Это значение не поддерживается до Windows Server 2008 R2 и Windows 7. вместо этого используется E_UNEXPECTED.

Комментарии

Windows 7, Windows Server 2008 R2, Windows Vista, Windows Server 2008, Windows XP и Windows Server 2003: Удаленные общие папки не поддерживаются до Windows 8 и Windows Server 2012.

Использование метода AddExcludeFilesFromSnapshot является необязательным. Записи должны использовать этот метод только для больших файлов, которые значительно изменяются между операциями теневого копирования.

Этот метод не заменяет метод IVssCreateWriterMetadata::AddExcludeFiles . Средства записи должны продолжать использовать метод AddExcludeFiles , чтобы сообщить, какие наборы файлов исключены из резервной копии.

Вызывающий объект отвечает за вызов метода IUnknown::Release для освобождения ресурсов возвращенного объекта IVssWMFiledesc .

Требования

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

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

IVssCreateWriterMetadata::AddExcludeFiles

IVssCreateWriterMetadataEx

IVssExamineWriterMetadataEx2::GetExcludeFromSnapshotCount

IVssExamineWriterMetadataEx2::GetExcludeFromSnapshotFile