Share via

IFileSyncScopeFilter::GetFilenameExcludes

  • Article

Gets the collection of file names to exclude from the scope.

HRESULT GetFilenameExcludes(
  LPWSTR pszFilenameExcludes,
  ULONG *pcchLength);

Parameters

  • pszFilenameExcludes
    [in, out, unique, size_is(*pcchLength)] Returns the semicolon-delimited list of file names that are excluded from the scope. When this value is the empty string, "", no files are excluded. The default value is the empty string, "".
  • pcchLength
    [in, out] Specifies the number of characters in pszFilenameExcludes. Returns the number of characters required to retrieve the list when pszFilenameExcludes is too small, or returns the number of characters written.

Return Value

  • S_OK.

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

  • E_OUTOFMEMORY.

Remarks

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

The file names in pszFilenameExcludes are evaluated by using the PathMatchSpec function. Directories are not evaluated against this exclusion list.

See Also

Reference

IFileSyncScopeFilter Interface