Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / IBatchUpdateable Interface / BeginUpdate Method / BeginUpdate(FileSystemEvents,Object) Method
A 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.


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

    Parameters

    events
    A 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 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.

    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