IFileSyncScopeFilter::GetFilenameIncludes
获取要在作用域中显式包括的文件名的集合。
HRESULT GetFilenameIncludes(
LPWSTR pszFilenameIncludes,
ULONG *pcchLength);
参数
- pszFilenameIncludes
[in, out, unique, size_is(*pcchLength)] 返回作用域中显式包括的文件名的分号分隔的列表。未包括在此列表中的文件将从作用域中排除。如果此值为空字符串 " "，则不会显式包括任何文件。默认值为 "*.*"。
- pcchLength
[in, out] 指定 pszFilenameIncludes 中的字符数。如果 pszFilenameIncludes 太小，则返回检索列表所需的字符数；否则返回写入的字符数。
返回值
S_OK。
如果 pszFilenameIncludes 太小，则返回值为 HRESULT_FROM_WIN32(ERROR_MORE_DATA)。在这种情况下，则在 pcchLength 中返回必需的字符数。
E_OUTOFMEMORY。
备注
在文件名中可以使用通配符（* 和 ?）。
显式包括的效果弱于排除的效果。因此，如果另一个筛选器排除了某个文件或文件夹，则将从作用域中排除该文件或文件夹，即使它显式包括在此列表中。
备注
未包括在 pszFilenameIncludes 中的文件将从作用域中排除。例如，如果将 pszFilenameIncludes 设置为空字符串 " "，则将从作用域中排除所有文件。