IdeaBlade DevForce 2010 Help Reference
InitializeDeflate(CompressionLevel,Boolean) Method
See Also  Send Feedback
IdeaBlade.Core Assembly > Ionic.Zlib Namespace > ZlibCodec Class > InitializeDeflate Method : InitializeDeflate(CompressionLevel,Boolean) Method



level
The compression level for the codec.
wantRfc1950Header
whether to emit an initial RFC1950 byte pair in the compressed stream.
Initialize the ZlibCodec for deflation operation, using the specified CompressionLevel, and the explicit flag governing whether to emit an RFC1950 header byte pair.

Syntax

Visual Basic (Declaration) 
Public Overloads Function InitializeDeflate( _
   ByVal level As CompressionLevel, _
   ByVal wantRfc1950Header As Boolean _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As ZlibCodec
Dim level As CompressionLevel
Dim wantRfc1950Header As Boolean
Dim value As Integer
 
value = instance.InitializeDeflate(level, wantRfc1950Header)
C# 
public int InitializeDeflate( 
   CompressionLevel level,
   bool wantRfc1950Header
)
C++/CLI 
public:
int InitializeDeflate( 
   CompressionLevel level,
   bool wantRfc1950Header
) 

Parameters

level
The compression level for the codec.
wantRfc1950Header
whether to emit an initial RFC1950 byte pair in the compressed stream.

Return Value

Z_OK if all goes well.

Remarks

The codec will use the maximum window bits (15) and the specified CompressionLevel. If you want to generate a zlib stream, you should specify true for wantRfc1950Header. In this case, the library will emit a ZLIB header, as defined in RFC 1950, in the compressed stream.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2013 All Rights Reserved.