Xceed .NET Libraries Documentation
BeginUpdate(FileSystemEvents,Object) Method


Xceed.GZip Assembly > Xceed.GZip Namespace > GZipArchive Class > BeginUpdate Method : BeginUpdate(FileSystemEvents,Object) Method
A Xceed.FileSystem.FileSystemEvents object that will be used to raise events. Cannot be a null reference (Nothing in Visual Basic).
Opaque data that will be passed back to the event handler when an event is raised.
Prevents a GZipArchive 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 GZipArchive
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 a null reference (Nothing in Visual Basic).
userData
Opaque data that will be passed back to the event handler when an event is raised.
Remarks

A call to BeingUpdate 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 gzip file
}
finally 
{
  i.EndUpdate();
}

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

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

GZipArchive Class
GZipArchive Members
Overload List