Xceed .NET Libraries Documentation
Xceed.Zip Assembly / Xceed.Zip Namespace / ZipArchive Class / BeginUpdate Method / BeginUpdate(FileSystemEvents,Object) Method
A Xceed.FileSystem.FileSystemEvents object that will be used to raise events. Cannot be NULL.
Opaque data that will be passed back to the event handler when an event is raised.


In This Topic
    BeginUpdate(FileSystemEvents,Object) Method
    In This Topic
    Prevents a ZipArchive object from modifying its underlying physical store until the EndUpdate method is called and raises events during the process.
    Syntax
    'Declaration
     
    
    Public Overloads Sub BeginUpdate( _
       ByVal events As FileSystemEvents, _
       ByVal userData As Object _
    ) 
    'Usage
     
    
    Dim instance As ZipArchive
    Dim events As FileSystemEvents
    Dim userData As Object
     
    instance.BeginUpdate(events, userData)
    public void BeginUpdate( 
       FileSystemEvents events,
       object userData
    )

    Parameters

    events
    A Xceed.FileSystem.FileSystemEvents object that will be used to raise events. Cannot be NULL.
    userData
    Opaque data that will be passed back to the event handler when an event is raised.
    Remarks

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

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

    In C#, the preferred way is to use the Xceed.FileSystem.AutoBatchUpdate class within 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