Share via


IFileSyncScopeFilter::SetFilenameIncludes

Sets the collection of file names to explicitly include in the scope.

Syntax

HRESULT SetFilenameIncludes(
  LPCWSTR pcszFilenameIncludes);

Parameters

  • pcszFilenameIncludes
    [in, string] The semicolon-delimited list of file names that are explicitly included in the scope. A file that is not included in this list is excluded from the scope. When this value is the empty string, " ", no files are explicitly included. The default value is "*.*".

Return Value

  • S_OK

Remarks

Wildcards (* and ?) can be used in file names.

Explicit inclusion is weaker than exclusion. Therefore, if a file or folder is excluded by some other filter, it will be excluded from the scope even if it is explicitly included in this list.

Note

A file that is not included in pszFilenameIncludes is excluded from the scope. For example, if pszFilenameIncludes is set to the empty string, " ", all files are excluded from the scope.

See Also

Reference

IFileSyncScopeFilter Interface