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


Xceed.Tar Assembly > Xceed.Tar Namespace > TarredFile Class > TarredFile Constructor : TarredFile 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.
Fully-qualified name of the file stored within the TAR file. This file may or may not exist within the TAR file.
Initializes a new instance of the TarredFile 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 fileName As String _
)
'Usage
 
Dim events As FileSystemEvents
Dim userData As Object
Dim tarFile As AbstractFile
Dim fileName As String
 
Dim instance As New TarredFile(events, userData, tarFile, fileName)
public TarredFile( 
   FileSystemEvents events,
   object userData,
   AbstractFile tarFile,
   string fileName
)

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.
fileName
Fully-qualified name of the file stored within the TAR file. This file may or may not exist within the TAR file.
Remarks

Once the TarredFile 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 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.

This implementation of Tar is fully read/write compatible with the USTAR format. It is read compatible with GNU Tar archives whose entries do not use the header extensions of this format.

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

TarredFile Class
TarredFile Members
Overload List