BZip2.BZ2Stream.Create

BZip2.BZ2Stream.Create

Method Signatures

 Shared Function Create(OutputStream As Writeable,  CompressionLevel As Integer = BZip2.Z_DEFAULT_COMPRESSION) As BZip2.BZ2Stream
 Shared Function Create(OutputStream As FolderItem, CompressionLevel As Integer = BZip2.Z_DEFAULT_COMPRESSION, Overwrite As Boolean = False) As BZip2.BZ2Stream

Parameters

Name	Type	Comment
OutputStream	Writeable, FolderItem	Compressed output will be written to this object
CompressionLevel	Integer	Optional. The compression level for the stream. Valid levels are 1(fast) to 9(best)
Overwrite	Boolean	Optional. If True, the OutputStream FolderItem is overwritten if it exists.

Return value

A new instance of BZ2Stream, or Nil on error

Remarks

Creates a new BZip2 stream for writing. Compressed data will be written to the OutputStream object.