Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / IBatchUpdateable Interface / BeginUpdate Method / BeginUpdate(FileSystemEvents,Object,Object) Method


In This Topic
    BeginUpdate(FileSystemEvents,Object,Object) Method
    In This Topic
    Prevents a AbstractFolder object from modifying its underlying physical store until the EndUpdate method is called.
    Syntax
    'Declaration
     
    
    Overloads Sub BeginUpdate( _
       ByVal events As FileSystemEvents, _
       ByVal userData As Object, _
       ByVal options As Object _
    ) 
    'Usage
     
    
    Dim instance As IBatchUpdateable
    Dim events As FileSystemEvents
    Dim userData As Object
    Dim options As Object
     
    instance.BeginUpdate(events, userData, options)

    Parameters

    events
    userData
    options
    Remarks

    A call to BeginUpdatemust be accompanied by a subsequent call to EndUpdate, or desynchronization can occur. One mean of making sure that both calls stay synchronized is to use a finally block:

    try { i.BeginUpdate(); // Do some modifications to the folder } finally { i.EndUpdate(); }

    In C#, the preferred way is to use the AutoBatchUpdate class in a using statement.

    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