Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.GZip Assembly / Xceed.GZip Namespace / GZippedFile Class / GZippedFile Constructor / GZippedFile Constructor(FileSystemEvents,Object,AbstractFile)
A Xceed.FileSystem.FileSystemEvents object that will be used to raise events. Cannot be NULL.
Opaque data that will be passed back to the event handler when an event is raised.
Xceed.FileSystem.AbstractFile object that represents the gzip file to access.
Example


In This Topic
    GZippedFile Constructor(FileSystemEvents,Object,AbstractFile)
    In This Topic
    Initializes a new instance of the GZippedFile class for accessing the first file in the GZip archive and enabling event notifications while the object is being created.
    Syntax
    'Declaration
 

    Public Function New( _
   ByVal events As FileSystemEvents, _
   ByVal userData As Object, _
   ByVal gzipFile As AbstractFile _
)
    'Usage
 

    Dim events As FileSystemEvents
Dim userData As Object
Dim gzipFile As AbstractFile
 
Dim instance As New GZippedFile(events, userData, gzipFile)
    public GZippedFile( 
   FileSystemEvents events,
   object userData,
   AbstractFile gzipFile
)

    Parameters

    events
    A Xceed.FileSystem.FileSystemEvents object that will be used to raise events. Cannot be NULL.
    userData
    Opaque data that will be passed back to the event handler when an event is raised.
    gzipFile
    Xceed.FileSystem.AbstractFile object that represents the gzip file to access.
    Example
    When the host file (gzipFile) is empty, calling this ctor returns a new reference on a file whose filename is deduced from the host file's filename, but does not create the item. Thus, calling this ctor twice in a row will return different filenames. Once an item is created, calling this ctor always returns that item. This outputs: file1: hello False file2: hello.2 False file1: hello False file2: hello.2 True file3: hello.2 True 
    AbstractFile hostFile = new DiskFile( @"d:\hello.gz" );

AbstractFile file1 = new GZippedFile( hostFile );
//Calling the constructor a second time when passing a host file that is empty will return a DIFFERENT filename.
AbstractFile file2 = new GZippedFile( hostFile );

Console.WriteLine( "file1: {0}   {1}", file1.Name, file1.Exists );
Console.WriteLine( "file2: {0}   {1}", file2.Name, file2.Exists );

//The item is created by calling the Create method.
file2.Create();

//Once the Create method has been called to create an item, calling the ctor always returns that item.
AbstractFile file3 = new GZippedFile( hostFile );

Console.WriteLine( "file1: {0}   {1}", file1.Name, file1.Exists );
Console.WriteLine( "file2: {0}   {1}", file2.Name, file2.Exists );
Console.WriteLine( "file3: {0}   {1}", file3.Name, file3.Exists );
    Example
    AbstractFile hostFile = new DiskFile( @"d:\hello.gz" ); AbstractFile file1 = new GZippedFile( hostFile ); //Calling the constructor a second time when passing a host file that is empty will return a DIFFERENT filename. AbstractFile file2 = new GZippedFile( hostFile ); Console.WriteLine( "file1: {0} {1}", file1.Name, file1.Exists ); Console.WriteLine( "file2: {0} {1}", file2.Name, file2.Exists ); //The item is created by calling the Create method. file2.Create(); //Once the Create method has been called to create an item, calling the ctor always returns that item. AbstractFile file3 = new GZippedFile( hostFile ); Console.WriteLine( "file1: {0} {1}", file1.Name, file1.Exists ); Console.WriteLine( "file2: {0} {1}", file2.Name, file2.Exists ); Console.WriteLine( "file3: {0} {1}", file3.Name, file3.Exists );
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    GZippedFile Class
    GZippedFile Members
    Overload List
    GZippedFile Class
    AbstractFile Class

    Send Feedback