FileSyncProvider.ScopeFilter Property

  • Article

Gets the static scope filter that specifies which files or directories in the local file store are included in the scope.

Namespace: Microsoft.Synchronization.Files
Assembly: Microsoft.Synchronization.Files (in microsoft.synchronization.files.dll)

Syntax

'Declaration
Public ReadOnly Property ScopeFilter As FileSyncScopeFilter
'Usage
Dim instance As FileSyncProvider
Dim value As FileSyncScopeFilter

value = instance.ScopeFilter

public FileSyncScopeFilter ScopeFilter { get; }

public:
property FileSyncScopeFilter^ ScopeFilter {
    FileSyncScopeFilter^ get ();
}

/** @property */
public FileSyncScopeFilter get_ScopeFilter ()

public function get ScopeFilter () : FileSyncScopeFilter

Property Value

The static scope filter that specifies which files or directories in the local file store are included in the scope. The default value is a null reference (Nothing in Visual Basic).

Remarks

The scope filter can be used to exclude a list of file names, exclude a list of subfolders, exclude files and folders based on their attributes, and explicitly include a list of file names.

The same filter should be used on both the source and destination providers, or unexpected results might occur.

The filter should be set the first time synchronization is performed and should remain the same in all subsequent synchronization sessions, or unexpected results might occur.

For more information about how to use the static scope filter, see Controlling Which Files Are Synchronized.

See Also

Reference

FileSyncProvider Class
FileSyncProvider Members
Microsoft.Synchronization.Files Namespace