InitializeDeflate Method (level, wantRfc1950Header)

Keyoti RapidSpell Desktop .NET

Initialize the ZlibCodec for deflation operation, using the specified CompressionLevel, and the explicit flag governing whether to emit an RFC1950 header byte pair.

Declaration Syntax

Visual Basic

Visual C++

public int InitializeDeflate(
	CompressionLevel level,
	bool wantRfc1950Header
)

public int InitializeDeflate(
	CompressionLevel level,
	bool wantRfc1950Header
)

Public Function InitializeDeflate ( 
	level As CompressionLevel,
	wantRfc1950Header As Boolean
) As Integer

Public Function InitializeDeflate ( 
	level As CompressionLevel,
	wantRfc1950Header As Boolean
) As Integer

public:
int InitializeDeflate(
	CompressionLevel level, 
	bool wantRfc1950Header
)

public:
int InitializeDeflate(
	CompressionLevel level, 
	bool wantRfc1950Header
)

member InitializeDeflate : 
        level : CompressionLevel * 
        wantRfc1950Header : bool -> int

member InitializeDeflate : 
        level : CompressionLevel * 
        wantRfc1950Header : bool -> int

Parameters

level (CompressionLevel): The compression level for the codec.

wantRfc1950Header (Boolean): whether to emit an initial RFC1950 byte pair in the compressed stream.

Return Value

Int32
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.

Assembly: Keyoti.RapidSpell.NET4 (Module: Keyoti.RapidSpell.NET4.dll) Version: 6.2.21.412