deflateSetDictionary Method

Initializes the compression dictionary from the given byte sequence without producing any compressed output.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#
C++/CLI

Public Function deflateSetDictionary( _
   ByVal dictionary() As Byte, _
   ByVal dictLength As Integer _
) As Integer

Dim instance As ZStream
Dim dictionary() As Byte
Dim dictLength As Integer
Dim value As Integer
 
value = instance.deflateSetDictionary(dictionary, dictLength)

public int deflateSetDictionary( 
   byte[] dictionary,
   int dictLength
)

public:
int deflateSetDictionary( 
   array<byte>^ dictionary,
   int dictLength
)

Parameters

dictionary: Data in the dictionary.
dictLength: Number of bytes in the dictionary.

Return Value

Zero on success, an error code on failure.

Remarks

This method must be called immediately after deflateInit(Int32), before any call to deflate.

The compressor and decompressor must use exactly the same dictionary (see inflateSetDictionary).

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

Reference

ZStream Class
ZStream Members