Метод IVssCreateWriterMetadata::AddExcludeFiles (vswriter.h)

Статья
08/27/2023

Метод AddExcludeFiles используется для явного исключения набора файлов (указанных файлов или файлов), которые в противном случае могут быть неявно включены при резервном копировании компонента текущего модуля записи.

Синтаксис

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

Параметры

[in] wszPath

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

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

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

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

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

[in] wszFilespec

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

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

[in] bRecursive

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

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

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

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

Значение	Значение
S_OK	Операция выполнена успешно.
E_INVALIDARG	Одно из значений параметра является недопустимым.
E_OUTOFMEMORY	Вызывающий объект не имеет памяти или других системных ресурсов.
VSS_E_INVALID_XML_DOCUMENT	Недопустимый XML-документ. Дополнительные сведения см. в журнале событий. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.
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. Средства записи поддерживают только локальные ресурсы — наборы файлов, абсолютный путь которых начинается с допустимой спецификации локального тома и не может быть сопоставленным сетевым диском. Поэтому входные путь (wszPath) в AddExcludeFiles (после разрешения любых переменных среды) должны иметь этот формат.

Например, часто бывает удобно определить компонент для включения всех файлов в заданном каталоге, а затем использовать AddExcludeFiles для явного удаления некоторых файлов (например, временных файлов) из резервной копии.

Дополнительные сведения об исключении файлов см. в разделе Спецификация исключения списка файлов.

Требования


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

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

IVssCreateWriterMetadata

IVssCreateWriterMetadata::AddComponent

Share via