IFileSyncScopeFilter::GetFilenameIncludes

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


HRESULT GetFilenameIncludes(
  LPWSTR pszFilenameIncludes,
  ULONG *pcchLength);

pszFilenameIncludes

[in, out, unique, size_is(*pcchLength)] Returns 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 "*.*".

pcchLength

[in, out] Specifies the number of characters in pszFilenameIncludes. Returns the number of characters required to retrieve the list when pszFilenameIncludes is too small, or returns the number of characters written.

  • S_OK.

  • HRESULT_FROM_WIN32(ERROR_MORE_DATA) when pszFilenameIncludes is too small. In this case, the required number of characters is returned in pcchLength.

  • E_OUTOFMEMORY.

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.

NoteNote

A file 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.

Show: