Xceed Logo
Shop
Xceed Real-Time Zip for .NET Documentation
Xceed.Zip Assembly / Xceed.Zip.ReaderWriter Namespace / ZipReader Class


In This Topic
    ZipReader Class
    In This Topic
    Represents an object used to read a Zip file passed to it as a stream.
    Syntax
    'Declaration
 
Public Class ZipReader 
   Implements System.IDisposable 
    'Usage
 
Dim instance As ZipReader
    public class ZipReader : System.IDisposable 
    Remarks
    Regardless of the compression method that is used, it is not possible to read 0-byte files.
    Inheritance Hierarchy

    System.Object
       Xceed.Zip.ReaderWriter.ZipReader

    Public Constructors
     NameDescription
    Public ConstructorZipReader ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyAesAlgorithmManagerGets or sets a manager object for the AES encryption functionality.  
    Public PropertyAllowInputStreamClosureGets or sets a boolean value indicating whether the input stream can be closed by the object.  
    Public PropertyDefaultPasswordTextEncoding  
    Public PropertyEncryptionPasswordGets or sets the encryption password that will be used to decrypt the files that are read from the zip stream.  
    Public PropertyIgnoredExtraHeaders  
    Public PropertyInputStreamGets the input Stream object that was specified at construction.  
    Public PropertyUseUnsafeCompressionMethodVersionsGets or sets a System.Boolean value that indicates whether the currently selected compression and decompression methods can use "unsafe" techniques like pointers to increase speed.  
    Top
    Public Methods
     NameDescription
    Public MethodDisposeOverloaded. Provides correct cleanup of resources in the base class and its derived classes.  
    Public MethodGetItemDataStreamReturns a new Stream object that implements a read-only stream around the ReadItemData method.  
    Public MethodReadEndHeaderReads the "Ending Header" in the zip stream and returns a ZipEndHeader object.  
    Public MethodReadItemDataOverloaded. Reads a sequence of bytes from the ZipReader's stream and advances the position within by the number of bytes read.  
    Public MethodReadItemLocalHeaderOverloaded. Reads the local header of the current item from the Zip file.  
    Top
    Public Events
     NameDescription
    Public EventByteProgressionRaised when ReadItemData has been called.  
    Public EventInvalidPasswordRaised when the supplied password is invalid.  
    Top
    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 Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    ZipReader Members
    Xceed.Zip.ReaderWriter Namespace

    Send Feedback