Xceed .NET Libraries Documentation
Xceed.Compression.Formats Assembly / Xceed.Compression.Formats Namespace / XceedCompressedStream Class
Members


In This Topic
    XceedCompressedStream Class
    In This Topic
    Represents a pass-through stream that reads and writes Xceed formatted compressed data.
    Syntax
    'Declaration
     
    Public Class XceedCompressedStream 
       Inherits FormattedCompressedStream
       Implements System.IDisposable 
    'Usage
     
    Dim instance As XceedCompressedStream
    public class XceedCompressedStream : FormattedCompressedStream, System.IDisposable  
    Remarks

    Compression is applied to data being written to the stream, and decompression is performed when data is read from the stream.

    By default, closing the XceedCompressedStream will also close the inner stream. This behavior can be modified by setting the FormattedCompressedStream.Transient property to true.

    To make sure that the header and footer are written, you can call FormattedCompressedStream.Write with 0 bytes. If neither FormattedCompressedStream.Write nor FormattedCompressedStream.Read has been called, the XceedCompressedStream does not know if it is reading or writing. To compress or decompress data compatible with the XceedCompression object of the ActiveX Xceed Zip Compression Library, use the XceedCompressedStreamEx class instead.
    Example
    Inheritance Hierarchy

    System.Object
       System.MarshalByRefObject
          System.IO.Stream
             Xceed.Compression.Formats.FormattedCompressedStream
                Xceed.Compression.Formats.XceedCompressedStream
                   Xceed.Compression.Formats.XceedCompressedStreamEx

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Fields
    Public Properties
     NameDescription
    Public PropertyGets a boolean value indicating whether the current stream supports reading. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public PropertyOverridden.   
    Public Property (Inherited from System.IO.Stream)
    Public PropertyGets a boolean value indicating whether the current stream supports writing. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public Property  
    Public PropertyGets or sets the encryption password that will be used to encrypt the files in the stream.  
    Public Property  
    Public Property (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public PropertyGets the length, in bytes, of the stream. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public PropertyGets or sets the position within the current stream. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public Property (Inherited from System.IO.Stream)
    Public PropertyGets or sets a boolean value indicating if the stream is responsible for closing its inner stream. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public Property (Inherited from System.IO.Stream)
    Top
    Public Methods
     NameDescription
    Public Method (Inherited from System.IO.Stream)
    Public Method (Inherited from System.IO.Stream)
    Public Method (Inherited from System.IO.Stream)
    Public Methodstatic (Shared in Visual Basic)Overloaded. Compresses an array of bytes using the Xceed compression format.  
    Public MethodOverloaded.  (Inherited from System.IO.Stream)
    Public MethodOverloaded.  (Inherited from System.IO.Stream)
    Public Method (Inherited from System.MarshalByRefObject)
    Public Methodstatic (Shared in Visual Basic)Overloaded. Decompresses an array of Xceed formatted compressed bytes.  
    Public MethodOverloaded. Releases all resources used by the FormattedCompressedStream. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public Method (Inherited from System.IO.Stream)
    Public Method (Inherited from System.IO.Stream)
    Public MethodClears all buffers for this stream and causes any buffered data to be written to the underlying compressed stream. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public MethodOverloaded.  (Inherited from System.IO.Stream)
    Public Method (Inherited from System.MarshalByRefObject)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodReads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public MethodOverloaded.  (Inherited from System.IO.Stream)
    Public Method (Inherited from System.IO.Stream)
    Public MethodSets the position within the current stream. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public MethodSets the length of the current stream. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public MethodWrites a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Public MethodOverloaded.  (Inherited from System.IO.Stream)
    Public Method (Inherited from System.IO.Stream)
    Top
    Protected Methods
     NameDescription
    Protected Method (Inherited from System.IO.Stream)
    Protected MethodAllows the FormattedCompressedStream object to attempt to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Protected MethodOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected Method (Inherited from System.IO.Stream)
    Protected MethodOverridden. This method is reserved for internal use and is not intended to be used directly from your code.  
    Protected MethodOverridden. This method is reserved for internal use and is not intended to be used directly from your code.  
    Protected Method (Inherited from Xceed.Compression.Formats.FormattedCompressedStream)
    Protected MethodOverridden. This method is reserved for internal use and is not intended to be used directly from your code.  
    Protected MethodOverridden. This method is reserved for internal use and is not intended to be used directly from your code.  
    Top
    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