MCL/sf/adapt/qemu: symbian-qemu-0.9.1-12/zlib-1.2.3/old/zlib.html@b842c0cb760e (annotated)

1 2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	1	<html>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	2	<head>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	3	<title>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	4	zlib general purpose compression library version 1.1.4
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	5	</title>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	6	</head>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	7	<body bgcolor="White" text="Black" vlink="Red" alink="Navy" link="Red">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	8	<!-- background="zlibbg.gif" -->
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	9
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	10	<h1> zlib 1.1.4 Manual </h1>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	11	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	12	<a name="Contents"><h2>Contents</h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	13	<ol type="I">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	14	<li> <a href="#Prologue">Prologue</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	15	<li> <a href="#Introduction">Introduction</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	16	<li> <a href="#Utility functions">Utility functions</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	17	<li> <a href="#Basic functions">Basic functions</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	18	<li> <a href="#Advanced functions">Advanced functions</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	19	<li> <a href="#Constants">Constants</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	20	<li> <a href="#struct z_stream_s">struct z_stream_s</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	21	<li> <a href="#Checksum functions">Checksum functions</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	22	<li> <a href="#Misc">Misc</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	23	</ol>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	24	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	25	<a name="Prologue"><h2> Prologue </h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	26	'zlib' general purpose compression library version 1.1.4, March 11th, 2002
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	27	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	28	Copyright (C) 1995-2002 Jean-loup Gailly and Mark Adler
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	29	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	30	This software is provided 'as-is', without any express or implied
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	31	warranty. In no event will the authors be held liable for any damages
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	32	arising from the use of this software.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	33	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	34	Permission is granted to anyone to use this software for any purpose,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	35	including commercial applications, and to alter it and redistribute it
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	36	freely, subject to the following restrictions:
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	37	<ol>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	38	<li> The origin of this software must not be misrepresented ; you must not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	39	claim that you wrote the original software. If you use this software
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	40	in a product, an acknowledgment in the product documentation would be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	41	appreciated but is not required.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	42	<li> Altered source versions must be plainly marked as such, and must not be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	43	misrepresented as being the original software.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	44	<li> This notice may not be removed or altered from any source distribution.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	45	</ol>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	46
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	47	<dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	48	<dt>Jean-loup Gailly
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	49	<dd><a href="mailto:jloup@gzip.org">jloup@gzip.org</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	50	<dt>Mark Adler
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	51	<dd><a href="mailto:madler@alumni.caltech.edu">madler@alumni.caltech.edu</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	52	</dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	53
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	54	The data format used by the zlib library is described by RFCs (Request for
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	55	Comments) 1950 to 1952 in the files
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	56	<a href="ftp://ds.internic.net/rfc/rfc1950.txt">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	57	ftp://ds.internic.net/rfc/rfc1950.txt </a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	58	(zlib format),
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	59	<a href="ftp://ds.internic.net/rfc/rfc1951.txt">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	60	rfc1951.txt </a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	61	(<a href="#deflate">deflate</a> format) and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	62	<a href="ftp://ds.internic.net/rfc/rfc1952.txt">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	63	rfc1952.txt </a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	64	(gzip format).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	65	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	66	This manual is converted from zlib.h by
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	67	<a href="mailto:piaip@csie.ntu.edu.tw"> piaip </a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	68	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	69	Visit <a href="http://ftp.cdrom.com/pub/infozip/zlib/">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	70	http://ftp.cdrom.com/pub/infozip/zlib/</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	71	for the official zlib web page.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	72	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	73
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	74	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	75	<a name="Introduction"><h2> Introduction </h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	76	The 'zlib' compression library provides in-memory compression and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	77	decompression functions, including integrity checks of the uncompressed
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	78	data. This version of the library supports only one compression method
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	79	(deflation) but other algorithms will be added later and will have the same
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	80	stream interface.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	81	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	82
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	83	Compression can be done in a single step if the buffers are large
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	84	enough (for example if an input file is mmap'ed), or can be done by
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	85	repeated calls of the compression function. In the latter case, the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	86	application must provide more input and/or consume the output
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	87	(providing more output space) before each call.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	88	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	89
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	90	The library also supports reading and writing files in gzip (.gz) format
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	91	with an interface similar to that of stdio.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	92	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	93
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	94	The library does not install any signal handler. The decoder checks
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	95	the consistency of the compressed data, so the library should never
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	96	crash even in case of corrupted input.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	97	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	98
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	99	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	100	<a name="Utility functions"><h2> Utility functions </h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	101	The following utility functions are implemented on top of the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	102	<a href="#Basic functions">basic stream-oriented functions</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	103	To simplify the interface, some
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	104	default options are assumed (compression level and memory usage,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	105	standard memory allocation functions). The source code of these
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	106	utility functions can easily be modified if you need special options.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	107	<h3> Function list </h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	108	<ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	109	<li> int <a href="#compress">compress</a> (Bytef dest, uLongf destLen, const Bytef *source, uLong sourceLen);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	110	<li> int <a href="#compress2">compress2</a> (Bytef dest, uLongf destLen, const Bytef *source, uLong sourceLen, int level);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	111	<li> int <a href="#uncompress">uncompress</a> (Bytef dest, uLongf destLen, const Bytef *source, uLong sourceLen);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	112	<li> typedef voidp gzFile;
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	113	<li> gzFile <a href="#gzopen">gzopen</a> (const char path, const char mode);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	114	<li> gzFile <a href="#gzdopen">gzdopen</a> (int fd, const char *mode);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	115	<li> int <a href="#gzsetparams">gzsetparams</a> (gzFile file, int level, int strategy);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	116	<li> int <a href="#gzread">gzread</a> (gzFile file, voidp buf, unsigned len);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	117	<li> int <a href="#gzwrite">gzwrite</a> (gzFile file, const voidp buf, unsigned len);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	118	<li> int VA <a href="#gzprintf">gzprintf</a> (gzFile file, const char *format, ...);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	119	<li> int <a href="#gzputs">gzputs</a> (gzFile file, const char *s);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	120	<li> char * <a href="#gzgets">gzgets</a> (gzFile file, char *buf, int len);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	121	<li> int <a href="#gzputc">gzputc</a> (gzFile file, int c);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	122	<li> int <a href="#gzgetc">gzgetc</a> (gzFile file);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	123	<li> int <a href="#gzflush">gzflush</a> (gzFile file, int flush);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	124	<li> z_off_t <a href="#gzseek">gzseek</a> (gzFile file, z_off_t offset, int whence);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	125	<li> z_off_t <a href="#gztell">gztell</a> (gzFile file);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	126	<li> int <a href="#gzrewind">gzrewind</a> (gzFile file);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	127	<li> int <a href="#gzeof">gzeof</a> (gzFile file);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	128	<li> int <a href="#gzclose">gzclose</a> (gzFile file);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	129	<li> const char * <a href="#gzerror">gzerror</a> (gzFile file, int *errnum);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	130	</ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	131	<h3> Function description </h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	132	<dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	133	<font color="Blue"><dt> int <a name="compress">compress</a> (Bytef dest, uLongf destLen, const Bytef *source, uLong sourceLen);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	134	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	135	Compresses the source buffer into the destination buffer. sourceLen is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	136	the byte length of the source buffer. Upon entry, destLen is the total
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	137	size of the destination buffer, which must be at least 0.1% larger than
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	138	sourceLen plus 12 bytes. Upon exit, destLen is the actual size of the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	139	compressed buffer.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	140	This function can be used to <a href="#compress">compress</a> a whole file at once if the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	141	input file is mmap'ed.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	142	<a href="#compress">compress</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a> if there was not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	143	enough memory, <a href="#Z_BUF_ERROR">Z_BUF_ERROR</a> if there was not enough room in the output
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	144	buffer.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	145
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	146	<font color="Blue"><dt> int <a name="compress2">compress2</a> (Bytef dest, uLongf destLen, const Bytef *source, uLong sourceLen, int level);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	147	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	148	Compresses the source buffer into the destination buffer. The level
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	149	parameter has the same meaning as in <a href="#deflateInit">deflateInit</a>. sourceLen is the byte
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	150	length of the source buffer. Upon entry, destLen is the total size of the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	151	destination buffer, which must be at least 0.1% larger than sourceLen plus
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	152	12 bytes. Upon exit, destLen is the actual size of the compressed buffer.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	153	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	154
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	155	<a href="#compress2">compress2</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a> if there was not enough
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	156	memory, <a href="#Z_BUF_ERROR">Z_BUF_ERROR</a> if there was not enough room in the output buffer,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	157	<a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the level parameter is invalid.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	158	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	159
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	160	<font color="Blue"><dt> int <a name="uncompress">uncompress</a> (Bytef dest, uLongf destLen, const Bytef *source, uLong sourceLen);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	161	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	162	Decompresses the source buffer into the destination buffer. sourceLen is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	163	the byte length of the source buffer. Upon entry, destLen is the total
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	164	size of the destination buffer, which must be large enough to hold the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	165	entire uncompressed data. (The size of the uncompressed data must have
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	166	been saved previously by the compressor and transmitted to the decompressor
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	167	by some mechanism outside the scope of this compression library.)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	168	Upon exit, destLen is the actual size of the compressed buffer. <p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	169	This function can be used to decompress a whole file at once if the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	170	input file is mmap'ed.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	171	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	172
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	173	<a href="#uncompress">uncompress</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a> if there was not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	174	enough memory, <a href="#Z_BUF_ERROR">Z_BUF_ERROR</a> if there was not enough room in the output
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	175	buffer, or <a href="#Z_DATA_ERROR">Z_DATA_ERROR</a> if the input data was corrupted.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	176	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	177
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	178	<dt> typedef voidp gzFile;
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	179	<dd> <p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	180
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	181	<font color="Blue"><dt> gzFile <a name="gzopen">gzopen</a> (const char path, const char mode);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	182	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	183	Opens a gzip (.gz) file for reading or writing. The mode parameter
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	184	is as in fopen ("rb" or "wb") but can also include a compression level
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	185	("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	186	Huffman only compression as in "wb1h". (See the description
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	187	of <a href="#deflateInit2">deflateInit2</a> for more information about the strategy parameter.)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	188	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	189
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	190	<a href="#gzopen">gzopen</a> can be used to read a file which is not in gzip format ; in this
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	191	case <a href="#gzread">gzread</a> will directly read from the file without decompression.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	192	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	193
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	194	<a href="#gzopen">gzopen</a> returns NULL if the file could not be opened or if there was
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	195	insufficient memory to allocate the (de)compression <a href="#state">state</a> ; errno
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	196	can be checked to distinguish the two cases (if errno is zero, the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	197	zlib error is <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a>).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	198	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	199
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	200	<font color="Blue"><dt> gzFile <a name="gzdopen">gzdopen</a> (int fd, const char *mode);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	201	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	202	<a href="#gzdopen">gzdopen</a>() associates a gzFile with the file descriptor fd. File
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	203	descriptors are obtained from calls like open, dup, creat, pipe or
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	204	fileno (in the file has been previously opened with fopen).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	205	The mode parameter is as in <a href="#gzopen">gzopen</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	206	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	207	The next call of <a href="#gzclose">gzclose</a> on the returned gzFile will also close the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	208	file descriptor fd, just like fclose(fdopen(fd), mode) closes the file
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	209	descriptor fd. If you want to keep fd open, use <a href="#gzdopen">gzdopen</a>(dup(fd), mode).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	210	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	211	<a href="#gzdopen">gzdopen</a> returns NULL if there was insufficient memory to allocate
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	212	the (de)compression <a href="#state">state</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	213	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	214
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	215	<font color="Blue"><dt> int <a name="gzsetparams">gzsetparams</a> (gzFile file, int level, int strategy);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	216	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	217	Dynamically update the compression level or strategy. See the description
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	218	of <a href="#deflateInit2">deflateInit2</a> for the meaning of these parameters.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	219	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	220	<a href="#gzsetparams">gzsetparams</a> returns <a href="#Z_OK">Z_OK</a> if success, or <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the file was not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	221	opened for writing.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	222	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	223
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	224	<font color="Blue"><dt> int <a name="gzread">gzread</a> (gzFile file, voidp buf, unsigned len);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	225	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	226	Reads the given number of uncompressed bytes from the compressed file.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	227	If the input file was not in gzip format, <a href="#gzread">gzread</a> copies the given number
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	228	of bytes into the buffer.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	229	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	230	<a href="#gzread">gzread</a> returns the number of uncompressed bytes actually read (0 for
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	231	end of file, -1 for error).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	232	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	233
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	234	<font color="Blue"><dt> int <a name="gzwrite">gzwrite</a> (gzFile file, const voidp buf, unsigned len);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	235	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	236	Writes the given number of uncompressed bytes into the compressed file.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	237	<a href="#gzwrite">gzwrite</a> returns the number of uncompressed bytes actually written
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	238	(0 in case of error).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	239	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	240
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	241	<font color="Blue"><dt> int VA <a name="gzprintf">gzprintf</a> (gzFile file, const char *format, ...);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	242	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	243	Converts, formats, and writes the args to the compressed file under
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	244	control of the format string, as in fprintf. <a href="#gzprintf">gzprintf</a> returns the number of
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	245	uncompressed bytes actually written (0 in case of error).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	246	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	247
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	248	<font color="Blue"><dt> int <a name="gzputs">gzputs</a> (gzFile file, const char *s);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	249	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	250	Writes the given null-terminated string to the compressed file, excluding
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	251	the terminating null character.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	252	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	253	<a href="#gzputs">gzputs</a> returns the number of characters written, or -1 in case of error.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	254	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	255
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	256	<font color="Blue"><dt> char * <a name="gzgets">gzgets</a> (gzFile file, char *buf, int len);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	257	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	258	Reads bytes from the compressed file until len-1 characters are read, or
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	259	a newline character is read and transferred to buf, or an end-of-file
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	260	condition is encountered. The string is then terminated with a null
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	261	character.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	262	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	263	<a href="#gzgets">gzgets</a> returns buf, or <a href="#Z_NULL">Z_NULL</a> in case of error.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	264	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	265
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	266	<font color="Blue"><dt> int <a name="gzputc">gzputc</a> (gzFile file, int c);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	267	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	268	Writes c, converted to an unsigned char, into the compressed file.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	269	<a href="#gzputc">gzputc</a> returns the value that was written, or -1 in case of error.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	270	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	271
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	272	<font color="Blue"><dt> int <a name="gzgetc">gzgetc</a> (gzFile file);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	273	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	274	Reads one byte from the compressed file. <a href="#gzgetc">gzgetc</a> returns this byte
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	275	or -1 in case of end of file or error.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	276	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	277
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	278	<font color="Blue"><dt> int <a name="gzflush">gzflush</a> (gzFile file, int flush);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	279	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	280	Flushes all pending output into the compressed file. The parameter
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	281	flush is as in the <a href="#deflate">deflate</a>() function. The return value is the zlib
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	282	error number (see function <a href="#gzerror">gzerror</a> below). <a href="#gzflush">gzflush</a> returns <a href="#Z_OK">Z_OK</a> if
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	283	the flush parameter is <a href="#Z_FINISH">Z_FINISH</a> and all output could be flushed.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	284	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	285	<a href="#gzflush">gzflush</a> should be called only when strictly necessary because it can
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	286	degrade compression.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	287	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	288
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	289	<font color="Blue"><dt> z_off_t <a name="gzseek">gzseek</a> (gzFile file, z_off_t offset, int whence);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	290	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	291	Sets the starting position for the next <a href="#gzread">gzread</a> or <a href="#gzwrite">gzwrite</a> on the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	292	given compressed file. The offset represents a number of bytes in the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	293	uncompressed data stream. The whence parameter is defined as in lseek(2);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	294	the value SEEK_END is not supported.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	295	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	296	If the file is opened for reading, this function is emulated but can be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	297	extremely slow. If the file is opened for writing, only forward seeks are
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	298	supported ; <a href="#gzseek">gzseek</a> then compresses a sequence of zeroes up to the new
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	299	starting position.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	300	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	301	<a href="#gzseek">gzseek</a> returns the resulting offset location as measured in bytes from
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	302	the beginning of the uncompressed stream, or -1 in case of error, in
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	303	particular if the file is opened for writing and the new starting position
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	304	would be before the current position.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	305	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	306
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	307	<font color="Blue"><dt> int <a name="gzrewind">gzrewind</a> (gzFile file);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	308	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	309	Rewinds the given file. This function is supported only for reading.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	310	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	311	<a href="#gzrewind">gzrewind</a>(file) is equivalent to (int)<a href="#gzseek">gzseek</a>(file, 0L, SEEK_SET)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	312	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	313
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	314	<font color="Blue"><dt> z_off_t <a name="gztell">gztell</a> (gzFile file);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	315	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	316	Returns the starting position for the next <a href="#gzread">gzread</a> or <a href="#gzwrite">gzwrite</a> on the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	317	given compressed file. This position represents a number of bytes in the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	318	uncompressed data stream.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	319	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	320
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	321	<a href="#gztell">gztell</a>(file) is equivalent to <a href="#gzseek">gzseek</a>(file, 0L, SEEK_CUR)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	322	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	323
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	324	<font color="Blue"><dt> int <a name="gzeof">gzeof</a> (gzFile file);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	325	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	326	Returns 1 when EOF has previously been detected reading the given
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	327	input stream, otherwise zero.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	328	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	329
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	330	<font color="Blue"><dt> int <a name="gzclose">gzclose</a> (gzFile file);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	331	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	332	Flushes all pending output if necessary, closes the compressed file
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	333	and deallocates all the (de)compression <a href="#state">state</a>. The return value is the zlib
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	334	error number (see function <a href="#gzerror">gzerror</a> below).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	335	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	336
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	337	<font color="Blue"><dt> const char * <a name="gzerror">gzerror</a> (gzFile file, int *errnum);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	338	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	339	Returns the error message for the last error which occurred on the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	340	given compressed file. errnum is set to zlib error number. If an
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	341	error occurred in the file system and not in the compression library,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	342	errnum is set to <a href="#Z_ERRNO">Z_ERRNO</a> and the application may consult errno
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	343	to get the exact error code.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	344	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	345	</dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	346	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	347	<a name="Basic functions"><h2> Basic functions </h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	348	<h3> Function list </h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	349	<ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	350	<li> const char * <a href="#zlibVersion">zlibVersion</a> (void);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	351	<li> int <a href="#deflateInit">deflateInit</a> (<a href="#z_streamp">z_streamp</a> strm, int level);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	352	<li> int <a href="#deflate">deflate</a> (<a href="#z_streamp">z_streamp</a> strm, int flush);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	353	<li> int <a href="#deflateEnd">deflateEnd</a> (<a href="#z_streamp">z_streamp</a> strm);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	354	<li> int <a href="#inflateInit">inflateInit</a> (<a href="#z_streamp">z_streamp</a> strm);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	355	<li> int <a href="#inflate">inflate</a> (<a href="#z_streamp">z_streamp</a> strm, int flush);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	356	<li> int <a href="#inflateEnd">inflateEnd</a> (<a href="#z_streamp">z_streamp</a> strm);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	357	</ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	358
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	359	<h3> Function description </h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	360	<dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	361	<font color="Blue"><dt> const char * <a name="zlibVersion">zlibVersion</a> (void);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	362	<dd> The application can compare <a href="#zlibVersion">zlibVersion</a> and ZLIB_VERSION for consistency.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	363	If the first character differs, the library code actually used is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	364	not compatible with the zlib.h header file used by the application.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	365	This check is automatically made by <a href="#deflateInit">deflateInit</a> and <a href="#inflateInit">inflateInit</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	366	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	367
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	368	<font color="Blue"><dt> int <a name="deflateInit">deflateInit</a> (<a href="#z_streamp">z_streamp</a> strm, int level);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	369	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	370	Initializes the internal stream <a href="#state">state</a> for compression. The fields
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	371	<a href="#zalloc">zalloc</a>, <a href="#zfree">zfree</a> and <a href="#opaque">opaque</a> must be initialized before by the caller.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	372	If <a href="#zalloc">zalloc</a> and <a href="#zfree">zfree</a> are set to <a href="#Z_NULL">Z_NULL</a>, <a href="#deflateInit">deflateInit</a> updates them to
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	373	use default allocation functions.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	374	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	375
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	376	The compression level must be <a href="#Z_DEFAULT_COMPRESSION">Z_DEFAULT_COMPRESSION</a>, or between 0 and 9:
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	377	1 gives best speed, 9 gives best compression, 0 gives no compression at
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	378	all (the input data is simply copied a block at a time).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	379	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	380
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	381	<a href="#Z_DEFAULT_COMPRESSION">Z_DEFAULT_COMPRESSION</a> requests a default compromise between speed and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	382	compression (currently equivalent to level 6).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	383	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	384
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	385	<a href="#deflateInit">deflateInit</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a> if there was not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	386	enough memory, <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if level is not a valid compression level,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	387	<a href="#Z_VERSION_ERROR">Z_VERSION_ERROR</a> if the zlib library version (<a href="#zlib_version">zlib_version</a>) is incompatible
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	388	with the version assumed by the caller (ZLIB_VERSION).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	389	<a href="#msg">msg</a> is set to null if there is no error message. <a href="#deflateInit">deflateInit</a> does not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	390	perform any compression: this will be done by <a href="#deflate">deflate</a>().
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	391	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	392
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	393	<font color="Blue"><dt> int <a name="deflate">deflate</a> (<a href="#z_streamp">z_streamp</a> strm, int flush);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	394	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	395	<a href="#deflate">deflate</a> compresses as much data as possible, and stops when the input
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	396	buffer becomes empty or the output buffer becomes full. It may introduce some
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	397	output latency (reading input without producing any output) except when
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	398	forced to flush.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	399
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	400	The detailed semantics are as follows. <a href="#deflate">deflate</a> performs one or both of the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	401	following actions:
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	402
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	403	<ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	404	<li> Compress more input starting at <a href="#next_in">next_in</a> and update <a href="#next_in">next_in</a> and <a href="#avail_in">avail_in</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	405	accordingly. If not all input can be processed (because there is not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	406	enough room in the output buffer), <a href="#next_in">next_in</a> and <a href="#avail_in">avail_in</a> are updated and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	407	processing will resume at this point for the next call of <a href="#deflate">deflate</a>().
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	408
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	409	<li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	410	Provide more output starting at <a href="#next_out">next_out</a> and update <a href="#next_out">next_out</a> and <a href="#avail_out">avail_out</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	411	accordingly. This action is forced if the parameter flush is non zero.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	412	Forcing flush frequently degrades the compression ratio, so this parameter
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	413	should be set only when necessary (in interactive applications).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	414	Some output may be provided even if flush is not set.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	415	</ul> <p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	416
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	417	Before the call of <a href="#deflate">deflate</a>(), the application should ensure that at least
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	418	one of the actions is possible, by providing more input and/or consuming
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	419	more output, and updating <a href="#avail_in">avail_in</a> or <a href="#avail_out">avail_out</a> accordingly ; <a href="#avail_out">avail_out</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	420	should never be zero before the call. The application can consume the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	421	compressed output when it wants, for example when the output buffer is full
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	422	(<a href="#avail_out">avail_out</a> == 0), or after each call of <a href="#deflate">deflate</a>(). If <a href="#deflate">deflate</a> returns <a href="#Z_OK">Z_OK</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	423	and with zero <a href="#avail_out">avail_out</a>, it must be called again after making room in the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	424	output buffer because there might be more output pending.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	425	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	426
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	427	If the parameter flush is set to <a href="#Z_SYNC_FLUSH">Z_SYNC_FLUSH</a>, all pending output is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	428	flushed to the output buffer and the output is aligned on a byte boundary, so
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	429	that the decompressor can get all input data available so far. (In particular
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	430	<a href="#avail_in">avail_in</a> is zero after the call if enough output space has been provided
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	431	before the call.) Flushing may degrade compression for some compression
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	432	algorithms and so it should be used only when necessary.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	433	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	434
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	435	If flush is set to <a href="#Z_FULL_FLUSH">Z_FULL_FLUSH</a>, all output is flushed as with
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	436	<a href="#Z_SYNC_FLUSH">Z_SYNC_FLUSH</a>, and the compression <a href="#state">state</a> is reset so that decompression can
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	437	restart from this point if previous compressed data has been damaged or if
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	438	random access is desired. Using <a href="#Z_FULL_FLUSH">Z_FULL_FLUSH</a> too often can seriously degrade
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	439	the compression.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	440	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	441
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	442	If <a href="#deflate">deflate</a> returns with <a href="#avail_out">avail_out</a> == 0, this function must be called again
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	443	with the same value of the flush parameter and more output space (updated
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	444	<a href="#avail_out">avail_out</a>), until the flush is complete (<a href="#deflate">deflate</a> returns with non-zero
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	445	<a href="#avail_out">avail_out</a>).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	446	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	447
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	448	If the parameter flush is set to <a href="#Z_FINISH">Z_FINISH</a>, pending input is processed,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	449	pending output is flushed and <a href="#deflate">deflate</a> returns with <a href="#Z_STREAM_END">Z_STREAM_END</a> if there
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	450	was enough output space ; if <a href="#deflate">deflate</a> returns with <a href="#Z_OK">Z_OK</a>, this function must be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	451	called again with <a href="#Z_FINISH">Z_FINISH</a> and more output space (updated <a href="#avail_out">avail_out</a>) but no
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	452	more input data, until it returns with <a href="#Z_STREAM_END">Z_STREAM_END</a> or an error. After
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	453	<a href="#deflate">deflate</a> has returned <a href="#Z_STREAM_END">Z_STREAM_END</a>, the only possible operations on the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	454	stream are <a href="#deflateReset">deflateReset</a> or <a href="#deflateEnd">deflateEnd</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	455	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	456
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	457	<a href="#Z_FINISH">Z_FINISH</a> can be used immediately after <a href="#deflateInit">deflateInit</a> if all the compression
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	458	is to be done in a single step. In this case, <a href="#avail_out">avail_out</a> must be at least
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	459	0.1% larger than <a href="#avail_in">avail_in</a> plus 12 bytes. If <a href="#deflate">deflate</a> does not return
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	460	<a href="#Z_STREAM_END">Z_STREAM_END</a>, then it must be called again as described above.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	461	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	462
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	463	<a href="#deflate">deflate</a>() sets strm-&gt <a href="#adler">adler</a> to the <a href="#adler32">adler32</a> checksum of all input read
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	464	so far (that is, <a href="#total_in">total_in</a> bytes).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	465	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	466
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	467	<a href="#deflate">deflate</a>() may update <a href="#data_type">data_type</a> if it can make a good guess about
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	468	the input data type (<a href="#Z_ASCII">Z_ASCII</a> or <a href="#Z_BINARY">Z_BINARY</a>). In doubt, the data is considered
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	469	binary. This field is only for information purposes and does not affect
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	470	the compression algorithm in any manner.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	471	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	472
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	473	<a href="#deflate">deflate</a>() returns <a href="#Z_OK">Z_OK</a> if some progress has been made (more input
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	474	processed or more output produced), <a href="#Z_STREAM_END">Z_STREAM_END</a> if all input has been
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	475	consumed and all output has been produced (only when flush is set to
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	476	<a href="#Z_FINISH">Z_FINISH</a>), <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the stream <a href="#state">state</a> was inconsistent (for example
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	477	if <a href="#next_in">next_in</a> or <a href="#next_out">next_out</a> was NULL), <a href="#Z_BUF_ERROR">Z_BUF_ERROR</a> if no progress is possible
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	478	(for example <a href="#avail_in">avail_in</a> or <a href="#avail_out">avail_out</a> was zero).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	479	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	480
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	481	<font color="Blue"><dt> int <a name="deflateEnd">deflateEnd</a> (<a href="#z_streamp">z_streamp</a> strm);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	482	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	483	All dynamically allocated data structures for this stream are freed.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	484	This function discards any unprocessed input and does not flush any
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	485	pending output.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	486	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	487
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	488	<a href="#deflateEnd">deflateEnd</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	489	stream <a href="#state">state</a> was inconsistent, <a href="#Z_DATA_ERROR">Z_DATA_ERROR</a> if the stream was freed
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	490	prematurely (some input or output was discarded). In the error case,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	491	<a href="#msg">msg</a> may be set but then points to a static string (which must not be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	492	deallocated).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	493	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	494
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	495	<font color="Blue"><dt> int <a name="inflateInit">inflateInit</a> (<a href="#z_streamp">z_streamp</a> strm);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	496	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	497	Initializes the internal stream <a href="#state">state</a> for decompression. The fields
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	498	<a href="#next_in">next_in</a>, <a href="#avail_in">avail_in</a>, <a href="#zalloc">zalloc</a>, <a href="#zfree">zfree</a> and <a href="#opaque">opaque</a> must be initialized before by
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	499	the caller. If <a href="#next_in">next_in</a> is not <a href="#Z_NULL">Z_NULL</a> and <a href="#avail_in">avail_in</a> is large enough (the exact
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	500	value depends on the compression method), <a href="#inflateInit">inflateInit</a> determines the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	501	compression method from the zlib header and allocates all data structures
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	502	accordingly ; otherwise the allocation will be deferred to the first call of
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	503	<a href="#inflate">inflate</a>. If <a href="#zalloc">zalloc</a> and <a href="#zfree">zfree</a> are set to <a href="#Z_NULL">Z_NULL</a>, <a href="#inflateInit">inflateInit</a> updates them to
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	504	use default allocation functions.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	505	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	506
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	507	<a href="#inflateInit">inflateInit</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a> if there was not enough
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	508	memory, <a href="#Z_VERSION_ERROR">Z_VERSION_ERROR</a> if the zlib library version is incompatible with the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	509	version assumed by the caller. <a href="#msg">msg</a> is set to null if there is no error
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	510	message. <a href="#inflateInit">inflateInit</a> does not perform any decompression apart from reading
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	511	the zlib header if present: this will be done by <a href="#inflate">inflate</a>(). (So <a href="#next_in">next_in</a> and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	512	<a href="#avail_in">avail_in</a> may be modified, but <a href="#next_out">next_out</a> and <a href="#avail_out">avail_out</a> are unchanged.)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	513	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	514
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	515	<font color="Blue"><dt> int <a name="inflate">inflate</a> (<a href="#z_streamp">z_streamp</a> strm, int flush);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	516	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	517	<a href="#inflate">inflate</a> decompresses as much data as possible, and stops when the input
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	518	buffer becomes empty or the output buffer becomes full. It may some
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	519	introduce some output latency (reading input without producing any output)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	520	except when forced to flush.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	521	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	522
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	523	The detailed semantics are as follows. <a href="#inflate">inflate</a> performs one or both of the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	524	following actions:
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	525
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	526	<ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	527	<li> Decompress more input starting at <a href="#next_in">next_in</a> and update <a href="#next_in">next_in</a> and <a href="#avail_in">avail_in</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	528	accordingly. If not all input can be processed (because there is not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	529	enough room in the output buffer), <a href="#next_in">next_in</a> is updated and processing
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	530	will resume at this point for the next call of <a href="#inflate">inflate</a>().
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	531
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	532	<li> Provide more output starting at <a href="#next_out">next_out</a> and update <a href="#next_out">next_out</a> and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	533	<a href="#avail_out">avail_out</a> accordingly. <a href="#inflate">inflate</a>() provides as much output as possible,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	534	until there is no more input data or no more space in the output buffer
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	535	(see below about the flush parameter).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	536	</ul> <p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	537
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	538	Before the call of <a href="#inflate">inflate</a>(), the application should ensure that at least
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	539	one of the actions is possible, by providing more input and/or consuming
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	540	more output, and updating the next_* and avail_* values accordingly.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	541	The application can consume the uncompressed output when it wants, for
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	542	example when the output buffer is full (<a href="#avail_out">avail_out</a> == 0), or after each
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	543	call of <a href="#inflate">inflate</a>(). If <a href="#inflate">inflate</a> returns <a href="#Z_OK">Z_OK</a> and with zero <a href="#avail_out">avail_out</a>, it
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	544	must be called again after making room in the output buffer because there
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	545	might be more output pending.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	546	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	547
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	548	If the parameter flush is set to <a href="#Z_SYNC_FLUSH">Z_SYNC_FLUSH</a>, <a href="#inflate">inflate</a> flushes as much
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	549	output as possible to the output buffer. The flushing behavior of <a href="#inflate">inflate</a> is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	550	not specified for values of the flush parameter other than <a href="#Z_SYNC_FLUSH">Z_SYNC_FLUSH</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	551	and <a href="#Z_FINISH">Z_FINISH</a>, but the current implementation actually flushes as much output
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	552	as possible anyway.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	553	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	554
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	555	<a href="#inflate">inflate</a>() should normally be called until it returns <a href="#Z_STREAM_END">Z_STREAM_END</a> or an
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	556	error. However if all decompression is to be performed in a single step
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	557	(a single call of <a href="#inflate">inflate</a>), the parameter flush should be set to
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	558	<a href="#Z_FINISH">Z_FINISH</a>. In this case all pending input is processed and all pending
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	559	output is flushed ; <a href="#avail_out">avail_out</a> must be large enough to hold all the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	560	uncompressed data. (The size of the uncompressed data may have been saved
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	561	by the compressor for this purpose.) The next operation on this stream must
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	562	be <a href="#inflateEnd">inflateEnd</a> to deallocate the decompression <a href="#state">state</a>. The use of <a href="#Z_FINISH">Z_FINISH</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	563	is never required, but can be used to inform <a href="#inflate">inflate</a> that a faster routine
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	564	may be used for the single <a href="#inflate">inflate</a>() call.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	565	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	566
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	567	If a preset dictionary is needed at this point (see <a href="#inflateSetDictionary">inflateSetDictionary</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	568	below), <a href="#inflate">inflate</a> sets strm-<a href="#adler">adler</a> to the <a href="#adler32">adler32</a> checksum of the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	569	dictionary chosen by the compressor and returns <a href="#Z_NEED_DICT">Z_NEED_DICT</a> ; otherwise
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	570	it sets strm-&gt <a href="#adler">adler</a> to the <a href="#adler32">adler32</a> checksum of all output produced
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	571	so far (that is, <a href="#total_out">total_out</a> bytes) and returns <a href="#Z_OK">Z_OK</a>, <a href="#Z_STREAM_END">Z_STREAM_END</a> or
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	572	an error code as described below. At the end of the stream, <a href="#inflate">inflate</a>()
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	573	checks that its computed <a href="#adler32">adler32</a> checksum is equal to that saved by the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	574	compressor and returns <a href="#Z_STREAM_END">Z_STREAM_END</a> only if the checksum is correct.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	575	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	576
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	577	<a href="#inflate">inflate</a>() returns <a href="#Z_OK">Z_OK</a> if some progress has been made (more input processed
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	578	or more output produced), <a href="#Z_STREAM_END">Z_STREAM_END</a> if the end of the compressed data has
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	579	been reached and all uncompressed output has been produced, <a href="#Z_NEED_DICT">Z_NEED_DICT</a> if a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	580	preset dictionary is needed at this point, <a href="#Z_DATA_ERROR">Z_DATA_ERROR</a> if the input data was
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	581	corrupted (input stream not conforming to the zlib format or incorrect
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	582	<a href="#adler32">adler32</a> checksum), <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the stream structure was inconsistent
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	583	(for example if <a href="#next_in">next_in</a> or <a href="#next_out">next_out</a> was NULL), <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a> if there was not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	584	enough memory, <a href="#Z_BUF_ERROR">Z_BUF_ERROR</a> if no progress is possible or if there was not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	585	enough room in the output buffer when <a href="#Z_FINISH">Z_FINISH</a> is used. In the <a href="#Z_DATA_ERROR">Z_DATA_ERROR</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	586	case, the application may then call <a href="#inflateSync">inflateSync</a> to look for a good
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	587	compression block.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	588	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	589
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	590	<font color="Blue"><dt> int <a name="inflateEnd">inflateEnd</a> (<a href="#z_streamp">z_streamp</a> strm);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	591	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	592	All dynamically allocated data structures for this stream are freed.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	593	This function discards any unprocessed input and does not flush any
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	594	pending output.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	595	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	596
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	597	<a href="#inflateEnd">inflateEnd</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the stream <a href="#state">state</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	598	was inconsistent. In the error case, <a href="#msg">msg</a> may be set but then points to a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	599	static string (which must not be deallocated).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	600	</dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	601	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	602	<a name="Advanced functions"><h2> Advanced functions </h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	603	The following functions are needed only in some special applications.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	604	<h3> Function list </h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	605	<ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	606	<li> int <a href="#deflateInit2">deflateInit2</a> (<a href="#z_streamp">z_streamp</a> strm,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	607	<li> int <a href="#deflateSetDictionary">deflateSetDictionary</a> (<a href="#z_streamp">z_streamp</a> strm, const Bytef *dictionary, uInt dictLength);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	608	<li> int <a href="#deflateCopy">deflateCopy</a> (<a href="#z_streamp">z_streamp</a> dest, <a href="#z_streamp">z_streamp</a> source);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	609	<li> int <a href="#deflateReset">deflateReset</a> (<a href="#z_streamp">z_streamp</a> strm);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	610	<li> int <a href="#deflateParams">deflateParams</a> (<a href="#z_streamp">z_streamp</a> strm, int level, int strategy);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	611	<li> int <a href="#inflateInit2">inflateInit2</a> (<a href="#z_streamp">z_streamp</a> strm, int windowBits);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	612	<li> int <a href="#inflateSetDictionary">inflateSetDictionary</a> (<a href="#z_streamp">z_streamp</a> strm, const Bytef *dictionary, uInt dictLength);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	613	<li> int <a href="#inflateSync">inflateSync</a> (<a href="#z_streamp">z_streamp</a> strm);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	614	<li> int <a href="#inflateReset">inflateReset</a> (<a href="#z_streamp">z_streamp</a> strm);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	615
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	616	</ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	617	<h3> Function description </h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	618	<dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	619	<font color="Blue"><dt> int <a name="deflateInit2">deflateInit2</a> (<a href="#z_streamp">z_streamp</a> strm, int level, int method, int windowBits, int memLevel, int strategy);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	620
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	621	<dd> This is another version of <a href="#deflateInit">deflateInit</a> with more compression options. The
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	622	fields <a href="#next_in">next_in</a>, <a href="#zalloc">zalloc</a>, <a href="#zfree">zfree</a> and <a href="#opaque">opaque</a> must be initialized before by
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	623	the caller.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	624
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	625	The method parameter is the compression method. It must be <a href="#Z_DEFLATED">Z_DEFLATED</a> in
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	626	this version of the library.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	627
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	628	The windowBits parameter is the base two logarithm of the window size
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	629	(the size of the history buffer). It should be in the range 8..15 for this
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	630	version of the library. Larger values of this parameter result in better
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	631	compression at the expense of memory usage. The default value is 15 if
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	632	<a href="#deflateInit">deflateInit</a> is used instead.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	633
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	634	The memLevel parameter specifies how much memory should be allocated
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	635	for the internal compression <a href="#state">state</a>. memLevel=1 uses minimum memory but
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	636	is slow and reduces compression ratio ; memLevel=9 uses maximum memory
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	637	for optimal speed. The default value is 8. See zconf.h for total memory
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	638	usage as a function of windowBits and memLevel.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	639
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	640	The strategy parameter is used to tune the compression algorithm. Use the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	641	value <a href="#Z_DEFAULT_STRATEGY">Z_DEFAULT_STRATEGY</a> for normal data, <a href="#Z_FILTERED">Z_FILTERED</a> for data produced by a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	642	filter (or predictor), or <a href="#Z_HUFFMAN_ONLY">Z_HUFFMAN_ONLY</a> to force Huffman encoding only (no
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	643	string match). Filtered data consists mostly of small values with a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	644	somewhat random distribution. In this case, the compression algorithm is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	645	tuned to <a href="#compress">compress</a> them better. The effect of <a href="#Z_FILTERED">Z_FILTERED</a> is to force more
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	646	Huffman coding and less string matching ; it is somewhat intermediate
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	647	between Z_DEFAULT and <a href="#Z_HUFFMAN_ONLY">Z_HUFFMAN_ONLY</a>. The strategy parameter only affects
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	648	the compression ratio but not the correctness of the compressed output even
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	649	if it is not set appropriately.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	650
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	651	<a href="#deflateInit2">deflateInit2</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a> if there was not enough
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	652	memory, <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if a parameter is invalid (such as an invalid
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	653	method). <a href="#msg">msg</a> is set to null if there is no error message. <a href="#deflateInit2">deflateInit2</a> does
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	654	not perform any compression: this will be done by <a href="#deflate">deflate</a>().<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	655
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	656	<font color="Blue"><dt> int <a name="deflateSetDictionary">deflateSetDictionary</a> (<a href="#z_streamp">z_streamp</a> strm, const Bytef *dictionary, uInt dictLength);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	657	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	658	Initializes the compression dictionary from the given byte sequence
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	659	without producing any compressed output. This function must be called
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	660	immediately after <a href="#deflateInit">deflateInit</a>, <a href="#deflateInit2">deflateInit2</a> or <a href="#deflateReset">deflateReset</a>, before any
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	661	call of <a href="#deflate">deflate</a>. The compressor and decompressor must use exactly the same
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	662	dictionary (see <a href="#inflateSetDictionary">inflateSetDictionary</a>).<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	663
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	664	The dictionary should consist of strings (byte sequences) that are likely
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	665	to be encountered later in the data to be compressed, with the most commonly
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	666	used strings preferably put towards the end of the dictionary. Using a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	667	dictionary is most useful when the data to be compressed is short and can be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	668	predicted with good accuracy ; the data can then be compressed better than
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	669	with the default empty dictionary.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	670
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	671	Depending on the size of the compression data structures selected by
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	672	<a href="#deflateInit">deflateInit</a> or <a href="#deflateInit2">deflateInit2</a>, a part of the dictionary may in effect be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	673	discarded, for example if the dictionary is larger than the window size in
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	674	<a href="#deflate">deflate</a> or deflate2. Thus the strings most likely to be useful should be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	675	put at the end of the dictionary, not at the front.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	676
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	677	Upon return of this function, strm-&gt <a href="#adler">adler</a> is set to the Adler32 value
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	678	of the dictionary ; the decompressor may later use this value to determine
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	679	which dictionary has been used by the compressor. (The Adler32 value
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	680	applies to the whole dictionary even if only a subset of the dictionary is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	681	actually used by the compressor.)<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	682
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	683	<a href="#deflateSetDictionary">deflateSetDictionary</a> returns <a href="#Z_OK">Z_OK</a> if success, or <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	684	parameter is invalid (such as NULL dictionary) or the stream <a href="#state">state</a> is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	685	inconsistent (for example if <a href="#deflate">deflate</a> has already been called for this stream
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	686	or if the compression method is bsort). <a href="#deflateSetDictionary">deflateSetDictionary</a> does not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	687	perform any compression: this will be done by <a href="#deflate">deflate</a>().<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	688
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	689	<font color="Blue"><dt> int <a name="deflateCopy">deflateCopy</a> (<a href="#z_streamp">z_streamp</a> dest, <a href="#z_streamp">z_streamp</a> source);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	690	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	691	Sets the destination stream as a complete copy of the source stream.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	692
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	693	This function can be useful when several compression strategies will be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	694	tried, for example when there are several ways of pre-processing the input
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	695	data with a filter. The streams that will be discarded should then be freed
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	696	by calling <a href="#deflateEnd">deflateEnd</a>. Note that <a href="#deflateCopy">deflateCopy</a> duplicates the internal
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	697	compression <a href="#state">state</a> which can be quite large, so this strategy is slow and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	698	can consume lots of memory.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	699
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	700	<a href="#deflateCopy">deflateCopy</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a> if there was not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	701	enough memory, <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the source stream <a href="#state">state</a> was inconsistent
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	702	(such as <a href="#zalloc">zalloc</a> being NULL). <a href="#msg">msg</a> is left unchanged in both source and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	703	destination.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	704
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	705	<font color="Blue"><dt> int <a name="deflateReset">deflateReset</a> (<a href="#z_streamp">z_streamp</a> strm);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	706	<dd> This function is equivalent to <a href="#deflateEnd">deflateEnd</a> followed by <a href="#deflateInit">deflateInit</a>,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	707	but does not free and reallocate all the internal compression <a href="#state">state</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	708	The stream will keep the same compression level and any other attributes
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	709	that may have been set by <a href="#deflateInit2">deflateInit2</a>.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	710
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	711	<a href="#deflateReset">deflateReset</a> returns <a href="#Z_OK">Z_OK</a> if success, or <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the source
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	712	stream <a href="#state">state</a> was inconsistent (such as <a href="#zalloc">zalloc</a> or <a href="#state">state</a> being NULL).<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	713
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	714	<font color="Blue"><dt> int <a name="deflateParams">deflateParams</a> (<a href="#z_streamp">z_streamp</a> strm, int level, int strategy);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	715	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	716	Dynamically update the compression level and compression strategy. The
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	717	interpretation of level and strategy is as in <a href="#deflateInit2">deflateInit2</a>. This can be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	718	used to switch between compression and straight copy of the input data, or
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	719	to switch to a different kind of input data requiring a different
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	720	strategy. If the compression level is changed, the input available so far
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	721	is compressed with the old level (and may be flushed); the new level will
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	722	take effect only at the next call of <a href="#deflate">deflate</a>().<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	723
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	724	Before the call of <a href="#deflateParams">deflateParams</a>, the stream <a href="#state">state</a> must be set as for
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	725	a call of <a href="#deflate">deflate</a>(), since the currently available input may have to
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	726	be compressed and flushed. In particular, strm-&gt <a href="#avail_out">avail_out</a> must be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	727	non-zero.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	728
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	729	<a href="#deflateParams">deflateParams</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the source
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	730	stream <a href="#state">state</a> was inconsistent or if a parameter was invalid, <a href="#Z_BUF_ERROR">Z_BUF_ERROR</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	731	if strm-&gtavail_out was zero.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	732
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	733	<font color="Blue"><dt> int <a name="inflateInit2">inflateInit2</a> (<a href="#z_streamp">z_streamp</a> strm, int windowBits);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	734
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	735	<dd> This is another version of <a href="#inflateInit">inflateInit</a> with an extra parameter. The
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	736	fields <a href="#next_in">next_in</a>, <a href="#avail_in">avail_in</a>, <a href="#zalloc">zalloc</a>, <a href="#zfree">zfree</a> and <a href="#opaque">opaque</a> must be initialized
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	737	before by the caller.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	738
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	739	The windowBits parameter is the base two logarithm of the maximum window
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	740	size (the size of the history buffer). It should be in the range 8..15 for
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	741	this version of the library. The default value is 15 if <a href="#inflateInit">inflateInit</a> is used
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	742	instead. If a compressed stream with a larger window size is given as
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	743	input, <a href="#inflate">inflate</a>() will return with the error code <a href="#Z_DATA_ERROR">Z_DATA_ERROR</a> instead of
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	744	trying to allocate a larger window.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	745
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	746	<a href="#inflateInit2">inflateInit2</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_MEM_ERROR">Z_MEM_ERROR</a> if there was not enough
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	747	memory, <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if a parameter is invalid (such as a negative
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	748	memLevel). <a href="#msg">msg</a> is set to null if there is no error message. <a href="#inflateInit2">inflateInit2</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	749	does not perform any decompression apart from reading the zlib header if
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	750	present: this will be done by <a href="#inflate">inflate</a>(). (So <a href="#next_in">next_in</a> and <a href="#avail_in">avail_in</a> may be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	751	modified, but <a href="#next_out">next_out</a> and <a href="#avail_out">avail_out</a> are unchanged.)<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	752
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	753	<font color="Blue"><dt> int <a name="inflateSetDictionary">inflateSetDictionary</a> (<a href="#z_streamp">z_streamp</a> strm, const Bytef *dictionary, uInt dictLength);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	754	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	755	Initializes the decompression dictionary from the given uncompressed byte
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	756	sequence. This function must be called immediately after a call of <a href="#inflate">inflate</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	757	if this call returned <a href="#Z_NEED_DICT">Z_NEED_DICT</a>. The dictionary chosen by the compressor
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	758	can be determined from the Adler32 value returned by this call of
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	759	<a href="#inflate">inflate</a>. The compressor and decompressor must use exactly the same
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	760	dictionary (see <a href="#deflateSetDictionary">deflateSetDictionary</a>).<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	761
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	762	<a href="#inflateSetDictionary">inflateSetDictionary</a> returns <a href="#Z_OK">Z_OK</a> if success, <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	763	parameter is invalid (such as NULL dictionary) or the stream <a href="#state">state</a> is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	764	inconsistent, <a href="#Z_DATA_ERROR">Z_DATA_ERROR</a> if the given dictionary doesn't match the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	765	expected one (incorrect Adler32 value). <a href="#inflateSetDictionary">inflateSetDictionary</a> does not
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	766	perform any decompression: this will be done by subsequent calls of
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	767	<a href="#inflate">inflate</a>().<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	768
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	769	<font color="Blue"><dt> int <a name="inflateSync">inflateSync</a> (<a href="#z_streamp">z_streamp</a> strm);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	770
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	771	<dd> Skips invalid compressed data until a full flush point (see above the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	772	description of <a href="#deflate">deflate</a> with <a href="#Z_FULL_FLUSH">Z_FULL_FLUSH</a>) can be found, or until all
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	773	available input is skipped. No output is provided.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	774
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	775	<a href="#inflateSync">inflateSync</a> returns <a href="#Z_OK">Z_OK</a> if a full flush point has been found, <a href="#Z_BUF_ERROR">Z_BUF_ERROR</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	776	if no more input was provided, <a href="#Z_DATA_ERROR">Z_DATA_ERROR</a> if no flush point has been found,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	777	or <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the stream structure was inconsistent. In the success
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	778	case, the application may save the current current value of <a href="#total_in">total_in</a> which
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	779	indicates where valid compressed data was found. In the error case, the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	780	application may repeatedly call <a href="#inflateSync">inflateSync</a>, providing more input each time,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	781	until success or end of the input data.<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	782
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	783	<font color="Blue"><dt> int <a name="inflateReset">inflateReset</a> (<a href="#z_streamp">z_streamp</a> strm);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	784	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	785	This function is equivalent to <a href="#inflateEnd">inflateEnd</a> followed by <a href="#inflateInit">inflateInit</a>,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	786	but does not free and reallocate all the internal decompression <a href="#state">state</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	787	The stream will keep attributes that may have been set by <a href="#inflateInit2">inflateInit2</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	788	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	789
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	790	<a href="#inflateReset">inflateReset</a> returns <a href="#Z_OK">Z_OK</a> if success, or <a href="#Z_STREAM_ERROR">Z_STREAM_ERROR</a> if the source
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	791	stream <a href="#state">state</a> was inconsistent (such as <a href="#zalloc">zalloc</a> or <a href="#state">state</a> being NULL).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	792	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	793	</dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	794
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	795	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	796	<a name="Checksum functions"><h2> Checksum functions </h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	797	These functions are not related to compression but are exported
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	798	anyway because they might be useful in applications using the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	799	compression library.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	800	<h3> Function list </h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	801	<ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	802	<li> uLong <a href="#adler32">adler32</a> (uLong <a href="#adler">adler</a>, const Bytef *buf, uInt len);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	803	<li> uLong <a href="#crc32">crc32</a> (uLong crc, const Bytef *buf, uInt len);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	804	</ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	805	<h3> Function description </h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	806	<dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	807	<font color="Blue"><dt> uLong <a name="adler32">adler32</a> (uLong <a href="#adler">adler</a>, const Bytef *buf, uInt len);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	808	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	809	Update a running Adler-32 checksum with the bytes buf[0..len-1] and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	810	return the updated checksum. If buf is NULL, this function returns
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	811	the required initial value for the checksum.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	812	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	813	An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	814	much faster. Usage example:
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	815	<pre>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	816
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	817	uLong <a href="#adler">adler</a> = <a href="#adler32">adler32</a>(0L, <a href="#Z_NULL">Z_NULL</a>, 0);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	818
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	819	while (read_buffer(buffer, length) != EOF) {
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	820	<a href="#adler">adler</a> = <a href="#adler32">adler32</a>(<a href="#adler">adler</a>, buffer, length);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	821	}
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	822	if (<a href="#adler">adler</a> != original_adler) error();
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	823	</pre>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	824
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	825	<font color="Blue"><dt> uLong <a name="crc32">crc32</a> (uLong crc, const Bytef *buf, uInt len);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	826	<dd>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	827	Update a running crc with the bytes buf[0..len-1] and return the updated
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	828	crc. If buf is NULL, this function returns the required initial value
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	829	for the crc. Pre- and post-conditioning (one's complement) is performed
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	830	within this function so it shouldn't be done by the application.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	831	Usage example:
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	832	<pre>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	833
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	834	uLong crc = <a href="#crc32">crc32</a>(0L, <a href="#Z_NULL">Z_NULL</a>, 0);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	835
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	836	while (read_buffer(buffer, length) != EOF) {
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	837	crc = <a href="#crc32">crc32</a>(crc, buffer, length);
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	838	}
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	839	if (crc != original_crc) error();
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	840	</pre>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	841	</dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	842	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	843	<a name="struct z_stream_s"><h2> struct z_stream_s </h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	844	<font color="Blue">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	845	<a name="z_stream_s">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	846	<pre>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	847	typedef struct z_stream_s {
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	848	Bytef <a name="next_in">next_in</a>; / next input byte */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	849	uInt <a name="avail_in">avail_in</a>; /* number of bytes available at <a href="#next_in">next_in</a> */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	850	uLong <a name="total_in">total_in</a>; /* total nb of input bytes read so far */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	851
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	852	Bytef <a name="next_out">next_out</a>; / next output byte should be put there */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	853	uInt <a name="avail_out">avail_out</a>; /* remaining free space at <a href="#next_out">next_out</a> */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	854	uLong <a name="total_out">total_out</a>; /* total nb of bytes output so far */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	855
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	856	char <a name="msg">msg</a>; / last error message, NULL if no error */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	857	struct internal_state FAR <a name="state">state</a>; / not visible by applications */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	858
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	859	alloc_func <a name="zalloc">zalloc</a>; /* used to allocate the internal <a href="#state">state</a> */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	860	free_func <a name="zfree">zfree</a>; /* used to free the internal <a href="#state">state</a> */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	861	voidpf <a name="opaque">opaque</a>; /* private data object passed to <a href="#zalloc">zalloc</a> and <a href="#zfree">zfree</a> */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	862
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	863	int <a name="data_type">data_type</a>; /* best guess about the data type: ascii or binary */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	864	uLong <a name="adler">adler</a>; /* <a href="#adler32">adler32</a> value of the uncompressed data */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	865	uLong <a name="reserved">reserved</a>; /* <a href="#reserved">reserved</a> for future use */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	866	} <a href="#z_stream_s">z_stream</a> ;
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	867
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	868	typedef <a href="#z_stream_s">z_stream</a> FAR * <a name="z_streamp">z_streamp</a>; ÿ
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	869	</pre>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	870	</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	871	The application must update <a href="#next_in">next_in</a> and <a href="#avail_in">avail_in</a> when <a href="#avail_in">avail_in</a> has
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	872	dropped to zero. It must update <a href="#next_out">next_out</a> and <a href="#avail_out">avail_out</a> when <a href="#avail_out">avail_out</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	873	has dropped to zero. The application must initialize <a href="#zalloc">zalloc</a>, <a href="#zfree">zfree</a> and
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	874	<a href="#opaque">opaque</a> before calling the init function. All other fields are set by the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	875	compression library and must not be updated by the application. <p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	876
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	877	The <a href="#opaque">opaque</a> value provided by the application will be passed as the first
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	878	parameter for calls of <a href="#zalloc">zalloc</a> and <a href="#zfree">zfree</a>. This can be useful for custom
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	879	memory management. The compression library attaches no meaning to the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	880	<a href="#opaque">opaque</a> value. <p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	881
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	882	<a href="#zalloc">zalloc</a> must return <a href="#Z_NULL">Z_NULL</a> if there is not enough memory for the object.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	883	If zlib is used in a multi-threaded application, <a href="#zalloc">zalloc</a> and <a href="#zfree">zfree</a> must be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	884	thread safe. <p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	885
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	886	On 16-bit systems, the functions <a href="#zalloc">zalloc</a> and <a href="#zfree">zfree</a> must be able to allocate
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	887	exactly 65536 bytes, but will not be required to allocate more than this
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	888	if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	889	pointers returned by <a href="#zalloc">zalloc</a> for objects of exactly 65536 bytes must
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	890	have their offset normalized to zero. The default allocation function
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	891	provided by this library ensures this (see zutil.c). To reduce memory
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	892	requirements and avoid any allocation of 64K objects, at the expense of
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	893	compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	894	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	895
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	896	The fields <a href="#total_in">total_in</a> and <a href="#total_out">total_out</a> can be used for statistics or
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	897	progress reports. After compression, <a href="#total_in">total_in</a> holds the total size of
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	898	the uncompressed data and may be saved for use in the decompressor
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	899	(particularly if the decompressor wants to decompress everything in
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	900	a single step). <p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	901
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	902	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	903	<a name="Constants"><h2> Constants </h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	904	<font color="Blue">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	905	<pre>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	906	#define <a name="Z_NO_FLUSH">Z_NO_FLUSH</a> 0
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	907	#define <a name="Z_PARTIAL_FLUSH">Z_PARTIAL_FLUSH</a> 1
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	908	/* will be removed, use <a href="#Z_SYNC_FLUSH">Z_SYNC_FLUSH</a> instead */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	909	#define <a name="Z_SYNC_FLUSH">Z_SYNC_FLUSH</a> 2
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	910	#define <a name="Z_FULL_FLUSH">Z_FULL_FLUSH</a> 3
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	911	#define <a name="Z_FINISH">Z_FINISH</a> 4
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	912	/* Allowed flush values ; see <a href="#deflate">deflate</a>() below for details */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	913
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	914	#define <a name="Z_OK">Z_OK</a> 0
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	915	#define <a name="Z_STREAM_END">Z_STREAM_END</a> 1
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	916	#define <a name="Z_NEED_DICT">Z_NEED_DICT</a> 2
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	917	#define <a name="Z_ERRNO">Z_ERRNO</a> (-1)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	918	#define <a name="Z_STREAM_ERROR">Z_STREAM_ERROR</a> (-2)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	919	#define <a name="Z_DATA_ERROR">Z_DATA_ERROR</a> (-3)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	920	#define <a name="Z_MEM_ERROR">Z_MEM_ERROR</a> (-4)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	921	#define <a name="Z_BUF_ERROR">Z_BUF_ERROR</a> (-5)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	922	#define <a name="Z_VERSION_ERROR">Z_VERSION_ERROR</a> (-6)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	923	/* Return codes for the compression/decompression functions. Negative
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	924	* values are errors, positive values are used for special but normal events.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	925	*/
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	926
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	927	#define <a name="Z_NO_COMPRESSION">Z_NO_COMPRESSION</a> 0
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	928	#define <a name="Z_BEST_SPEED">Z_BEST_SPEED</a> 1
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	929	#define <a name="Z_BEST_COMPRESSION">Z_BEST_COMPRESSION</a> 9
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	930	#define <a name="Z_DEFAULT_COMPRESSION">Z_DEFAULT_COMPRESSION</a> (-1)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	931	/* compression levels */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	932
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	933	#define <a name="Z_FILTERED">Z_FILTERED</a> 1
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	934	#define <a name="Z_HUFFMAN_ONLY">Z_HUFFMAN_ONLY</a> 2
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	935	#define <a name="Z_DEFAULT_STRATEGY">Z_DEFAULT_STRATEGY</a> 0
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	936	/* compression strategy ; see <a href="#deflateInit2">deflateInit2</a>() below for details */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	937
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	938	#define <a name="Z_BINARY">Z_BINARY</a> 0
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	939	#define <a name="Z_ASCII">Z_ASCII</a> 1
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	940	#define <a name="Z_UNKNOWN">Z_UNKNOWN</a> 2
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	941	/* Possible values of the <a href="#data_type">data_type</a> field */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	942
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	943	#define <a name="Z_DEFLATED">Z_DEFLATED</a> 8
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	944	/* The <a href="#deflate">deflate</a> compression method (the only one supported in this version) */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	945
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	946	#define <a name="Z_NULL">Z_NULL</a> 0 /* for initializing <a href="#zalloc">zalloc</a>, <a href="#zfree">zfree</a>, <a href="#opaque">opaque</a> */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	947
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	948	#define <a name="zlib_version">zlib_version</a> <a href="#zlibVersion">zlibVersion</a>()
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	949	/* for compatibility with versions less than 1.0.2 */
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	950	</pre>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	951	</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	952
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	953	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	954	<a name="Misc"><h2> Misc </h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	955	<a href="#deflateInit">deflateInit</a> and <a href="#inflateInit">inflateInit</a> are macros to allow checking the zlib version
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	956	and the compiler's view of <a href="#z_stream_s">z_stream</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	957	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	958	Other functions:
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	959	<dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	960	<font color="Blue"><dt> const char * <a name="zError">zError</a> (int err);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	961	<font color="Blue"><dt> int <a name="inflateSyncPoint">inflateSyncPoint</a> (<a href="#z_streamp">z_streamp</a> z);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	962	<font color="Blue"><dt> const uLongf * <a name="get_crc_table">get_crc_table</a> (void);</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	963	</dl>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	964	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	965	<font size="-1">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	966	Last update: Wed Oct 13 20:42:34 1999<br>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	967	piapi@csie.ntu.edu.tw
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	968	</font>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	969
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	970	</body>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	971	</html>

author	Gareth Stockwell <gareth.stockwell@accenture.com>
	Wed, 22 Sep 2010 20:10:53 +0100
branch	graphics-phase-3
changeset 113	b842c0cb760e
parent 1	2fb8b9db1c86
permissions	-rw-r--r--