Xceed .NET Libraries Documentation
XceedCompressedStream Constructor(Stream,CompressionMethod,CompressionLevel,Boolean,String)


Xceed.Compression.Formats Assembly > Xceed.Compression.Formats Namespace > XceedCompressedStream Class > XceedCompressedStream Constructor : XceedCompressedStream Constructor(Stream,CompressionMethod,CompressionLevel,Boolean,String)
The stream to write to and read from.
A Xceed.Compression.CompressionMethod value representing the compression method to use.
A Xceed.Compression.CompressionLevel value representing the compression level to use.
If true, this stream can only be read from and the header will be read immediately. If false, this stream can be used for reading or writing but no header is read until a call to FormattedCompressedStream.Write or FormattedCompressedStream.Read.
A string containing the encryption password that will be used to encrypt the files in the stream.
Initializes a new instance of the XceedCompressedStream class specifying the inner stream to write to and read from, the compression method and level to use, and the encryption password.
Syntax
'Declaration
 
Public Function New( _

   ByVal inner As Stream, _

   ByVal method As CompressionMethod, _

   ByVal level As CompressionLevel, _

   ByVal readHeader As Boolean, _

   ByVal encryptionPassword As String _

)
'Usage
 
Dim inner As Stream

Dim method As CompressionMethod

Dim level As CompressionLevel

Dim readHeader As Boolean

Dim encryptionPassword As String

 

Dim instance As New XceedCompressedStream(inner, method, level, readHeader, encryptionPassword)
public XceedCompressedStream( 

   Stream inner,

   CompressionMethod method,

   CompressionLevel level,

   bool readHeader,

   string encryptionPassword

)

Parameters

inner
The stream to write to and read from.
method
A Xceed.Compression.CompressionMethod value representing the compression method to use.
level
A Xceed.Compression.CompressionLevel value representing the compression level to use.
readHeader
If true, this stream can only be read from and the header will be read immediately. If false, this stream can be used for reading or writing but no header is read until a call to FormattedCompressedStream.Write or FormattedCompressedStream.Read.
encryptionPassword
A string containing the encryption password that will be used to encrypt the files in the stream.
Remarks
The Stored compression method is not supported.
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

XceedCompressedStream Class
XceedCompressedStream Members
Overload List