Xceed .NET Libraries Documentation
TarredFolder Constructor(FileSystemEvents,Object,AbstractFile,String)


Xceed.Tar Assembly > Xceed.Tar Namespace > TarredFolder Class > TarredFolder Constructor : TarredFolder Constructor(FileSystemEvents,Object,AbstractFile,String)
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.
Xceed.FileSystem.AbstractFile object that represents the TAR file to access. Cannot be a null reference (Nothing in Visual Basic).
Fully-qualified name of the folder stored in the TAR file. This folder may or may not exist in the TAR file. Cannot be a null reference (Nothing in Visual Basic).
Initializes a new instance of the TarredFolder class enabling event notifications while the object is being created.
Syntax
'Declaration
 
Public Function New( _

   ByVal events As FileSystemEvents, _

   ByVal userData As Object, _

   ByVal tarFile As AbstractFile, _

   ByVal folderName As String _

)
'Usage
 
Dim events As FileSystemEvents

Dim userData As Object

Dim tarFile As AbstractFile

Dim folderName As String

 

Dim instance As New TarredFolder(events, userData, tarFile, folderName)
public TarredFolder( 

   FileSystemEvents events,

   object userData,

   AbstractFile tarFile,

   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.
tarFile
Xceed.FileSystem.AbstractFile object that represents the TAR file to access. Cannot be a null reference (Nothing in Visual Basic).
folderName
Fully-qualified name of the folder stored in the TAR file. This folder may or may not exist in the TAR file. Cannot be a null reference (Nothing in Visual Basic).
Remarks

Once the TarredFolder 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 TAR file when creating new instances of either TarArchive, TarredFile or TarredFolder otherwise, when updating the TAR 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.

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

TarredFolder Class
TarredFolder Members
Overload List