InitializeInflate Method (windowBits, expectRfc1950Header)

Keyoti RapidSpell Desktop .NET

Initialize the inflation state with an explicit flag to govern the handling of RFC1950 header bytes.

Declaration Syntax

Visual Basic

Visual C++

public int InitializeInflate(
	int windowBits,
	bool expectRfc1950Header
)

public int InitializeInflate(
	int windowBits,
	bool expectRfc1950Header
)

Public Function InitializeInflate ( 
	windowBits As Integer,
	expectRfc1950Header As Boolean
) As Integer

Public Function InitializeInflate ( 
	windowBits As Integer,
	expectRfc1950Header As Boolean
) As Integer

public:
int InitializeInflate(
	int windowBits, 
	bool expectRfc1950Header
)

public:
int InitializeInflate(
	int windowBits, 
	bool expectRfc1950Header
)

member InitializeInflate : 
        windowBits : int * 
        expectRfc1950Header : bool -> int

member InitializeInflate : 
        windowBits : int * 
        expectRfc1950Header : bool -> int

Parameters

windowBits (Int32): The number of window bits to use. If you need to ask what that is, then you shouldn't be calling this initializer.

expectRfc1950Header (Boolean): whether to expect an RFC1950 header byte pair when reading the stream of data to be inflated.

Return Value

Int32
Z_OK if everything goes well.

Remarks

If you want to read a zlib stream you should specify true for expectRfc1950Header. In this case, the library will expect to find a ZLIB header, as defined in RFC 1950, in the compressed stream. If you will be reading a DEFLATE or GZIP stream, which does not have such a header, you will want to specify false.

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