Xceed .NET Libraries Documentation
Xceed.Synchronization Assembly / Xceed.Synchronization Namespace / SynchronizationOptions Class / ProcessUnnecessaryFolders Field


In This Topic
    ProcessUnnecessaryFolders Field
    In This Topic

    A boolean value indicating whether, during a folder synchronization, a folder should be processed even if this is deemed logically unnecessary by the synchronization algorithm.

    If set to true, unnecessary folders are scanned for files to synchronize as normal. If set to false, the files in unnecessary folders are ignored completely by the algorithm.

    Syntax
    'Declaration
     
    
    Public ProcessUnnecessaryFolders As Boolean
    'Usage
     
    
    Dim instance As SynchronizationOptions
    Dim value As Boolean
     
    value = instance.ProcessUnnecessaryFolders
     
    instance.ProcessUnnecessaryFolders = value
    public bool ProcessUnnecessaryFolders
    Remarks

    A folder can be deemed unnesessary to process when a combination of synchronization parameters and options are set to certain values. The combination is as follows:

    • The supplied items to synchronize are all folders, obviously.
    • A master folder was manually specified when the Synchronizer.Synchronize method was called
    • The AllowDeletions field is set to false.

    Consider, when a master item is manually specified, synchronizations will only go one way, from the file in the master folder to the target folders, in every case. Now, combine that with deletions not being allowed and you have a situation where files in the target folders that don't already exist in the master folder will never be acted upon. And files that only exist in the target folders will, obviously, not be copied to the master folder nor be deleted. So the entire target folders can be considered unnecessary to be scanned on their own.

    This is, however, something to consider. If the value of this field is false and target folders are deemed unnecessary, events related to the synchronization of files in these folders will not be triggered.

    The default value of this field is true.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also