ZippedFolder Constructor(FileSystemEvents,Object,AbstractFile,String)

Initializes a new instance of the ZippedFolder class enabling event notifications while the object is being created.

Syntax

Visual Basic
C#

'Declaration
 
Public Function New( _

   ByVal events As Xceed.FileSystem.FileSystemEvents, _

   ByVal userData As Object, _

   ByVal zipFile As Xceed.FileSystem.AbstractFile, _

   ByVal folderName As String _

)

'Usage
 
Dim events As Xceed.FileSystem.FileSystemEvents

Dim userData As Object

Dim zipFile As Xceed.FileSystem.AbstractFile

Dim folderName As String

 

Dim instance As New ZippedFolder(events, userData, zipFile, folderName)

public ZippedFolder( 

   Xceed.FileSystem.FileSystemEvents events,

   object userData,

   Xceed.FileSystem.AbstractFile zipFile,

   string folderName

)

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.
zipFile: Xceed.FileSystem.AbstractFile object that represents the ZIP file to access.
folderName: Fully-qualified name of the folder stored in the ZIP file. This folder may or may not exist in the ZIP file.

Remarks

Once the ZippedFolder object is created, it does not keep a reference on the event object.

It is important to always use the same instance of the AbstractFile representing the actual zip file when creating new instances of either ZipArchive, ZippedFile or ZippedFolder otherwise, when updating the zip file through different instances, information can be lost. Instances obtained from calls to GetFile, GetFiles (and all) are safe, and share the same original AbstractFile.

Example

The code below shows a possible loss of data:

DiskFile source1 = new DiskFile( @"D:\First.txt" );

DiskFile source2 = new DiskFile( @"D:\Second.txt" );



DiskFile file1 = new DiskFile( @"D:\Danger.zip" );

DiskFile file2 = new DiskFile( @"D:\Danger.zip" );



ZipArchive zip1 = new ZipArchive( file1 );

ZipArchive zip2 = new ZipArchive( file2 );



zip1.BeginUpdate();

source1.CopyTo( zip1, true );



zip2.BeginUpdate();

source2.CopyTo( zip2, true );

zip2.EndUpdate();  // Zip file updated with "Second.txt"

zip1.EndUpdate();  // Zip file updated with "First.txt" but "Second.txt" gets lost

                   

The correct may to deal with many instances of a ZipArchive is:



DiskFile source1 = new DiskFile( @"D:\First.txt" );

DiskFile source2 = new DiskFile( @"D:\Second.txt" );



DiskFile singleFile = new DiskFile( @"D:\Danger.zip" );



ZipArchive zip1 = new ZipArchive( singleFile );

ZipArchive zip2 = new ZipArchive( singleFile );



zip1.BeginUpdate();

source1.CopyTo( zip1, true );



zip2.BeginUpdate();

source2.CopyTo( zip2, true );

zip2.EndUpdate();  // Zip file not updated right away

zip1.EndUpdate();  // Zip file updated with both "First.txt" and "Second.txt"

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

Reference

ZippedFolder Class
ZippedFolder Members
Overload List