IFileSyncScopeFilter::GetSubDirectoryExcludes
Gets the collection of relative paths of directories to exclude from the scope.
HRESULT GetSubDirectoryExcludes(
LPWSTR pszSubDirectoryExcludes,
ULONG *pcchLength);
Parameters
- pszSubDirectoryExcludes
[in, out, unique, size_is(*pcchLength)] Returns the semicolon-delimited list of directories that are excluded from the scope. When this value is the empty string, " ", no directories are excluded. The default value is the empty string, " ".
- pcchLength
[in, out] Specifies the number of characters in pszSubDirectoryExcludes. Returns the number of characters required to retrieve the list when pszSubDirectoryExcludes is too small, or returns the number of characters written.
Return Value
S_OK.
HRESULT_FROM_WIN32(ERROR_MORE_DATA) when pszSubDirectoryExcludes is too small. In this case, the required number of characters is returned in pcchLength.
E_OUTOFMEMORY.
Remarks
Wildcards (* and ?) can be used in directory paths.
Excluding a directory excludes all files and subdirectories that are contained in that directory.
The paths that are contained in pcszSubDirectoryExcludes can be absolute or relative. Relative paths are relative to the root directory of the replica as specified in the IFileSyncProvider::Initialize method.