IFileSyncScopeFilter::GetFilenameIncludes

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

HRESULT GetFilenameIncludes(
  LPWSTR pszFilenameIncludes,
  ULONG *pcchLength);

Параметры

• pszFilenameIncludes
  [in, out, unique, size_is(*pcchLength)] Возвращает список имен файлов, явным образом включенных в область. Элементы списка разделяются точками с запятой. Файл, не включенный в этот список, исключается из области. Если это значение равно пустой строке (""), то явным образом не будет включено ни одного файла. Значение по умолчанию — "*.*".

• pcchLength
  [in, out] Указывает длину pszFilenameIncludes в символах. Возвращает количество символов, необходимое для получения списка, если размер pszFilenameIncludes слишком мал, либо возвращает число записанных символов.

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

• S_OK.

• HRESULT_FROM_WIN32(ERROR_MORE_DATA), если размер pszFilenameIncludes слишком мал. В этом случае необходимое количество символов возвращается в pcchLength.

• E_OUTOFMEMORY.

Замечания

В именах файлов можно применять шаблоны (* и ?).

Явное включение является менее приоритетным, чем исключение. Таким образом, если файл или папка исключены каким-либо фильтром, то они будут исключены из области даже в том случае, если их явным образом включить в этот список.

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

См. также

Справочник

Интерфейс IFileSyncScopeFilter