Edit D:\app\Administrator\product\11.2.0\dbhome_1\perl\html\lib\Compress\Raw\Zlib.html

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Compress::Raw::Zlib - Low-Level Interface to zlib compression library</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>

<body style="background-color: white">
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="block" style="background-color: #cccccc" valign="middle">
<big>&nbsp;Compress::Raw::Zlib - Low-Level Interface to zlib compression library</big>
</td></tr>
</table>

<div name="index">
<a name="__index__"></a>

<ul>

<li><a href="#name">NAME</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#compress__raw__zlib__deflate">Compress::Raw::Zlib::Deflate</a></li>
	<ul>

<li><a href="#__d___status____new_compress__raw__zlib__deflate___opt___">($d, $status) = new Compress::Raw::Zlib::Deflate( [OPT] ) </a></li>
		<li><a href="#_status____d__deflate__input___output_">$status = $d-&gt;deflate($input, $output)</a></li>
		<li><a href="#_status____d__flush__output_____flush_type__">$status = $d-&gt;flush($output [, $flush_type]) </a></li>
		<li><a href="#_status____d__deflateparams__opt__">$status = $d-&gt;deflateParams([OPT])</a></li>
		<li><a href="#_status____d__deflatetune__good_length___max_lazy___nice_length___max_chain_">$status = $d-&gt;deflateTune($good_length, $max_lazy, $nice_length, $max_chain)</a></li>
		<li><a href="#_d__dict_adler__">$d-&gt;dict_adler()</a></li>
		<li><a href="#_d__crc32__">$d-&gt;crc32()</a></li>
		<li><a href="#_d__adler32__">$d-&gt;adler32()</a></li>
		<li><a href="#_d__msg__">$d-&gt;msg()</a></li>
		<li><a href="#_d__total_in__">$d-&gt;total_in()</a></li>
		<li><a href="#_d__total_out__">$d-&gt;total_out()</a></li>
		<li><a href="#_d__get_strategy__">$d-&gt;get_Strategy()</a></li>
		<li><a href="#_d__get_level__">$d-&gt;get_Level()</a></li>
		<li><a href="#_d__get_bufsize__">$d-&gt;get_BufSize()</a></li>
		<li><a href="#example">Example</a></li>
	</ul>

<li><a href="#compress__raw__zlib__inflate">Compress::Raw::Zlib::Inflate</a></li>
	<ul>

<li><a href="#__i___status____new_compress__raw__zlib__inflate___opt___"> ($i, $status) = new Compress::Raw::Zlib::Inflate( [OPT] ) </a></li>
		<li><a href="#_status____i__inflate__input___output____eof__"> $status = $i-&gt;inflate($input, $output [,$eof]) </a></li>
		<li><a href="#_status____i__inflatesync__input_">$status = $i-&gt;inflateSync($input)</a></li>
		<li><a href="#_i__dict_adler__">$i-&gt;dict_adler()</a></li>
		<li><a href="#_i__crc32__">$i-&gt;crc32()</a></li>
		<li><a href="#_i__adler32__">$i-&gt;adler32()</a></li>
		<li><a href="#_i__msg__">$i-&gt;msg()</a></li>
		<li><a href="#_i__total_in__">$i-&gt;total_in()</a></li>
		<li><a href="#_i__total_out__">$i-&gt;total_out()</a></li>
		<li><a href="#_d__get_bufsize__">$d-&gt;get_BufSize()</a></li>
		<li><a href="#example">Example</a></li>
	</ul>

<li><a href="#checksum_functions">CHECKSUM FUNCTIONS</a></li>
	<li><a href="#accessing_zip_files">ACCESSING ZIP FILES</a></li>
	<li><a href="#constants">CONSTANTS</a></li>
	<li><a href="#see_also">SEE ALSO</a></li>
	<li><a href="#author">AUTHOR</a></li>
	<li><a href="#modification_history">MODIFICATION HISTORY</a></li>
	<li><a href="#copyright_and_license">COPYRIGHT AND LICENSE</a></li>
</ul>

<h1><a name="name">NAME</a></h1>
Compress::Raw::Zlib - Low-Level Interface to zlib compression library


<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
 use Compress::Raw::Zlib ;</pre>
<pre>
 ($d, $status) = new Compress::Raw::Zlib::Deflate( [OPT] ) ;
 $status = $d-&gt;deflate($input, $output) ;
 $status = $d-&gt;flush($output [, $flush_type]) ;
 $d-&gt;deflateParams(OPTS) ;
 $d-&gt;deflateTune(OPTS) ;
 $d-&gt;dict_adler() ;
 $d-&gt;crc32() ;
 $d-&gt;adler32() ;
 $d-&gt;total_in() ;
 $d-&gt;total_out() ;
 $d-&gt;msg() ;
 $d-&gt;get_Strategy();
 $d-&gt;get_Level();
 $d-&gt;get_BufSize();</pre>
<pre>
 ($i, $status) = new Compress::Raw::Zlib::Inflate( [OPT] ) ;
 $status = $i-&gt;inflate($input, $output [, $eof]) ;
 $status = $i-&gt;inflateSync($input) ;
 $i-&gt;dict_adler() ;
 $d-&gt;crc32() ;
 $d-&gt;adler32() ;
 $i-&gt;total_in() ;
 $i-&gt;total_out() ;
 $i-&gt;msg() ;
 $d-&gt;get_BufSize();</pre>
<pre>
 $crc = adler32($buffer [,$crc]) ;
 $crc = crc32($buffer [,$crc]) ;</pre>
<pre>
 $crc = adler32_combine($crc1, $crc2, $len2)l
 $crc = crc32_combine($adler1, $adler2, $len2)</pre>
<pre>
 ZLIB_VERSION
 ZLIB_VERNUM</pre>


<hr />
<h1><a name="description">DESCRIPTION</a></h1>
The Compress::Raw::Zlib module provides a Perl interface to the zlib
compression library (see <a href="#author">AUTHOR</a> for details about where to get
zlib).


<hr />
<h1><a name="compress__raw__zlib__deflate">Compress::Raw::Zlib::Deflate</a></h1>
This section defines an interface that allows in-memory compression using
the deflate interface provided by zlib.
Here is a definition of the interface available:


<h2><a name="__d___status____new_compress__raw__zlib__deflate___opt___">($d, $status) = new Compress::Raw::Zlib::Deflate( [OPT] ) </a></h2>
Initialises a deflation object.
If you are familiar with the zlib library, it combines the
features of the zlib functions <code>deflateInit</code>, <code>deflateInit2</code>
and <code>deflateSetDictionary</code>.
If successful, it will return the initialised deflation object, <code>$d</code>
and a <code>$status</code> of <code>Z_OK</code> in a list context. In scalar context it
returns the deflation object, <code>$d</code>, only.
If not successful, the returned deflation object, <code>$d</code>, will be
undef and <code>$status</code> will hold the a zlib error code.
The function optionally takes a number of named options specified as
<code>Name =&gt; value</code> pairs. This allows individual options to be
tailored without having to specify them all in the parameter list.
For backward compatibility, it is also possible to pass the parameters
as a reference to a hash containing the name=&gt;value pairs.
Below is a list of the valid options:
<dl>
<dt><a name="level" class="item">-Level</a>

<dd>
Defines the compression level. Valid values are 0 through 9,
<code>Z_NO_COMPRESSION</code>, <code>Z_BEST_SPEED</code>, <code>Z_BEST_COMPRESSION</code>, and
<code>Z_DEFAULT_COMPRESSION</code>.
</dd>
<dd>
The default is Z_DEFAULT_COMPRESSION.
</dd>
</li>
<dt><a name="method" class="item">-Method</a>

<dd>
Defines the compression method. The only valid value at present (and
the default) is Z_DEFLATED.
</dd>
</li>
<dt><a name="windowbits" class="item">-WindowBits</a>

<dd>
For a definition of the meaning and valid values for <a href="#windowbits"><code>WindowBits</code></a>
refer to the zlib documentation for deflateInit2.
</dd>
<dd>
Defaults to MAX_WBITS.
</dd>
</li>
<dt><a name="memlevel" class="item">-MemLevel</a>

<dd>
For a definition of the meaning and valid values for <a href="#memlevel"><code>MemLevel</code></a>
refer to the zlib documentation for deflateInit2.
</dd>
<dd>
Defaults to MAX_MEM_LEVEL.
</dd>
</li>
<dt><a name="strategy" class="item">-Strategy</a>

<dd>
Defines the strategy used to tune the compression. The valid values are
<code>Z_DEFAULT_STRATEGY</code>, <code>Z_FILTERED</code>, <code>Z_RLE</code>, <code>Z_FIXED</code> and
<code>Z_HUFFMAN_ONLY</code>.
</dd>
<dd>
The default is Z_DEFAULT_STRATEGY.
</dd>
</li>
<dt><a name="dictionary" class="item">-Dictionary</a>

<dd>
When a dictionary is specified Compress::Raw::Zlib will automatically
call <code>deflateSetDictionary</code> directly after calling <code>deflateInit</code>. The
Adler32 value for the dictionary can be obtained by calling the method 
<code>$d-&gt;dict_adler()</code>.
</dd>
<dd>
The default is no dictionary.
</dd>
</li>
<dt><a name="bufsize" class="item">-Bufsize</a>

<dd>
This option controls how data is written to the output buffer by the
<code>$d-&gt;deflate</code> and <code>$d-&gt;flush</code> methods.
</dd>
<dd>
If the <a href="#appendoutput"><code>AppendOutput</code></a> option is set to false, the output buffers in the
<code>$d-&gt;deflate</code> and <code>$d-&gt;flush</code> methods will be truncated before
uncompressed data is written to them.
</dd>
<dd>
If the option is set to true, uncompressed data will be appended to the
output buffer in the <code>$d-&gt;deflate</code> and <code>$d-&gt;flush</code> methods.
</dd>
<dd>
This option defaults to false.
</dd>
</li>
<dt><a name="crc32" class="item">-CRC32</a>

<dd>
If set to true, a crc32 checksum of the uncompressed data will be
calculated. Use the <code>$d-&gt;crc32</code> method to retrieve this value.
</dd>
<dd>
This option defaults to false.
</dd>
</li>
<dt><a name="adler32" class="item">-ADLER32</a>

<dd>
If set to true, an adler32 checksum of the uncompressed data will be
calculated. Use the <code>$d-&gt;adler32</code> method to retrieve this value.
</dd>
<dd>
This option defaults to false.
</dd>
</li>
</dl>
Here is an example of using the <code>Compress::Raw::Zlib::Deflate</code> optional
parameter list to override the default buffer size and compression
level. All other options will take their default values.
<pre>
 my $d = new Compress::Raw::Zlib::Deflate ( -Bufsize =&gt; 300, 
 -Level =&gt; Z_BEST_SPEED ) ;</pre>


<h2><a name="_status____d__deflate__input___output_">$status = $d-&gt;deflate($input, $output)</a></h2>
Deflates the contents of <code>$input</code> and writes the compressed data to
<code>$output</code>.
The <code>$input</code> and <code>$output</code> parameters can be either scalars or scalar
references.
When finished, <code>$input</code> will be completely processed (assuming there
were no errors). If the deflation was successful it writes the deflated
data to <code>$output</code> and returns a status value of <code>Z_OK</code>.
On error, it returns a zlib error code.
If the <a href="#appendoutput"><code>AppendOutput</code></a> option is set to true in the constructor for
the <code>$d</code> object, the compressed data will be appended to <code>$output</code>. If
it is false, <code>$output</code> will be truncated before any compressed data is
written to it.
Note: This method will not necessarily write compressed data to
<code>$output</code> every time it is called. So do not assume that there has been
an error if the contents of <code>$output</code> is empty on returning from
this method. As long as the return code from the method is <code>Z_OK</code>,
the deflate has succeeded.


<h2><a name="_status____d__flush__output_____flush_type__">$status = $d-&gt;flush($output [, $flush_type]) </a></h2>
Typically used to finish the deflation. Any pending output will be
written to <code>$output</code>.
Returns <code>Z_OK</code> if successful.
Note that flushing can seriously degrade the compression ratio, so it
should only be used to terminate a decompression (using <code>Z_FINISH</code>) or
when you want to create a full flush point (using <code>Z_FULL_FLUSH</code>).
By default the <code>flush_type</code> used is <code>Z_FINISH</code>. Other valid values
for <code>flush_type</code> are <code>Z_NO_FLUSH</code>, <code>Z_PARTIAL_FLUSH</code>, <code>Z_SYNC_FLUSH</code>
and <code>Z_FULL_FLUSH</code>. It is strongly recommended that you only set the
<code>flush_type</code> parameter if you fully understand the implications of
what it does. See the <code>zlib</code> documentation for details.
If the <a href="#appendoutput"><code>AppendOutput</code></a> option is set to true in the constructor for
the <code>$d</code> object, the compressed data will be appended to <code>$output</code>. If
it is false, <code>$output</code> will be truncated before any compressed data is
written to it.


<h2><a name="_status____d__deflateparams__opt__">$status = $d-&gt;deflateParams([OPT])</a></h2>
Change settings for the deflate object <code>$d</code>.
The list of the valid options is shown below. Options not specified
will remain unchanged.
<dl>
<dt><a name="level2" class="item">-Level</a>

<dd>
Defines the compression level. Valid values are 0 through 9,
<code>Z_NO_COMPRESSION</code>, <code>Z_BEST_SPEED</code>, <code>Z_BEST_COMPRESSION</code>, and
<code>Z_DEFAULT_COMPRESSION</code>.
</dd>
</li>
<dt><a name="strategy2" class="item">-Strategy</a>

<dd>
Defines the strategy used to tune the compression. The valid values are
<code>Z_DEFAULT_STRATEGY</code>, <code>Z_FILTERED</code> and <code>Z_HUFFMAN_ONLY</code>.
</dd>
</li>
<dt><a name="bufsize" class="item">-BufSize</a>

<dd>
Sets the initial size for the output buffer used by the <code>$d-&gt;deflate</code>
and <code>$d-&gt;flush</code> methods. If the buffer has to be
reallocated to increase the size, it will grow in increments of
<a href="#bufsize"><code>Bufsize</code></a>.
</dd>
</li>
</dl>


<h2><a name="_status____d__deflatetune__good_length___max_lazy___nice_length___max_chain_">$status = $d-&gt;deflateTune($good_length, $max_lazy, $nice_length, $max_chain)</a></h2>
Tune the internal settings for the deflate object <code>$d</code>. This option is
only available if you are running zlib 1.2.2.3 or better.
Refer to the documentation in zlib.h for instructions on how to fly
<code>deflateTune</code>.


<h2><a name="_d__dict_adler__">$d-&gt;dict_adler()</a></h2>
Returns the adler32 value for the dictionary.


<h2><a name="_d__crc32__">$d-&gt;crc32()</a></h2>
Returns the crc32 value for the uncompressed data to date.
If the <a href="#crc32"><code>CRC32</code></a> option is not enabled in the constructor for this object,
this method will always return 0;


<h2><a name="_d__adler32__">$d-&gt;adler32()</a></h2>
Returns the adler32 value for the uncompressed data to date.


<h2><a name="_d__msg__">$d-&gt;msg()</a></h2>
Returns the last error message generated by zlib.


<h2><a name="_d__total_in__">$d-&gt;total_in()</a></h2>
Returns the total number of bytes uncompressed bytes input to deflate.


<h2><a name="_d__total_out__">$d-&gt;total_out()</a></h2>
Returns the total number of compressed bytes output from deflate.


<h2><a name="_d__get_strategy__">$d-&gt;get_Strategy()</a></h2>
Returns the deflation strategy currently used. Valid values are
<code>Z_DEFAULT_STRATEGY</code>, <code>Z_FILTERED</code> and <code>Z_HUFFMAN_ONLY</code>.


<h2><a name="_d__get_level__">$d-&gt;get_Level()</a></h2>
Returns the compression level being used.


<h2><a name="_d__get_bufsize__">$d-&gt;get_BufSize()</a></h2>
Returns the buffer size used to carry out the compression.


<h2><a name="example">Example</a></h2>
Here is a trivial example of using <code>deflate</code>. It simply reads standard
input, deflates it and writes it to standard output.
<pre>
 use strict ;
 use warnings ;</pre>
<pre>
 use Compress::Raw::Zlib ;</pre>
<pre>
 binmode STDIN;
 binmode STDOUT;
 my $x = new Compress::Raw::Zlib::Deflate
 or die &quot;Cannot create a deflation stream\n&quot; ;</pre>
<pre>
 my ($output, $status) ;
 while (&lt;&gt;)
 {
 $status = $x-&gt;deflate($_, $output) ;
 
 $status == Z_OK
 or die &quot;deflation failed\n&quot; ;
 
 print $output ;
 }
 
 $status = $x-&gt;flush($output) ;
 
 $status == Z_OK
 or die &quot;deflation failed\n&quot; ;
 
 print $output ;</pre>


<hr />
<h1><a name="compress__raw__zlib__inflate">Compress::Raw::Zlib::Inflate</a></h1>
This section defines an interface that allows in-memory uncompression using
the inflate interface provided by zlib.
Here is a definition of the interface:


<h2><a name="__i___status____new_compress__raw__zlib__inflate___opt___"> ($i, $status) = new Compress::Raw::Zlib::Inflate( [OPT] ) </a></h2>
Initialises an inflation object.
In a list context it returns the inflation object, <code>$i</code>, and the
zlib status code (<code>$status</code>). In a scalar context it returns the
inflation object only.
If successful, <code>$i</code> will hold the inflation object and <code>$status</code> will
be <code>Z_OK</code>.
If not successful, <code>$i</code> will be undef and <code>$status</code> will hold the
zlib error code.
The function optionally takes a number of named options specified as
<code>-Name =&gt; value</code> pairs. This allows individual options to be
tailored without having to specify them all in the parameter list.
For backward compatibility, it is also possible to pass the parameters
as a reference to a hash containing the <code>name=&gt;value</code> pairs.
Here is a list of the valid options:
<dl>
<dt><a name="windowbits2" class="item">-WindowBits</a>

<dd>
To uncompress an <a href="http://www.ietf.org/rfc/rfc1950.txt" class="rfc">RFC 1950</a> data stream, set <a href="#windowbits"><code>WindowBits</code></a> to a positive
number.
</dd>
<dd>
To uncompress an <a href="http://www.ietf.org/rfc/rfc1951.txt" class="rfc">RFC 1951</a> data stream, set <a href="#windowbits"><code>WindowBits</code></a> to <code>-MAX_WBITS</code>.
</dd>
<dd>
For a full definition of the meaning and valid values for <a href="#windowbits"><code>WindowBits</code></a>
refer to the zlib documentation for inflateInit2.
</dd>
<dd>
Defaults to MAX_WBITS.
</dd>
</li>
<dt><a name="bufsize2" class="item">-Bufsize</a>

<dd>
Sets the initial size for the output buffer used by the <code>$i-&gt;inflate</code>
method. If the output buffer in this method has to be reallocated to
increase the size, it will grow in increments of <a href="#bufsize"><code>Bufsize</code></a>.
</dd>
<dd>
Default is 4096.
</dd>
</li>
<dt><a name="dictionary2" class="item">-Dictionary</a>

<dd>
The default is no dictionary.
</dd>
</li>
<dt><a name="appendoutput2" class="item">-AppendOutput</a>

<dd>
This option controls how data is written to the output buffer by the
<code>$i-&gt;inflate</code> method.
</dd>
<dd>
If the option is set to false, the output buffer in the <code>$i-&gt;inflate</code>
method will be truncated before uncompressed data is written to it.
</dd>
<dd>
If the option is set to true, uncompressed data will be appended to the
output buffer by the <code>$i-&gt;inflate</code> method.
</dd>
<dd>
This option defaults to false.
</dd>
</li>
<dt><a name="crc322" class="item">-CRC32</a>

<dd>
If set to true, a crc32 checksum of the uncompressed data will be
calculated. Use the <code>$i-&gt;crc32</code> method to retrieve this value.
</dd>
<dd>
This option defaults to false.
</dd>
</li>
<dt><a name="adler322" class="item">-ADLER32</a>

<dd>
If set to true, an adler32 checksum of the uncompressed data will be
calculated. Use the <code>$i-&gt;adler32</code> method to retrieve this value.
</dd>
<dd>
This option defaults to false.
</dd>
</li>
<dt><a name="consumeinput" class="item">-ConsumeInput</a>

<dd>
If set to true, this option will remove compressed data from the input
buffer of the the <code> $i-&gt;inflate </code> method as the inflate progresses.
</dd>
<dd>
This option can be useful when you are processing compressed data that is
embedded in another file/buffer. In this case the data that immediately
follows the compressed stream will be left in the input buffer.
</dd>
<dd>
This option defaults to true.
</dd>
</li>
</dl>
Here is an example of using an optional parameter to override the default
buffer size.
<pre>
 my ($i, $status) = new Compress::Raw::Zlib::Inflate( -Bufsize =&gt; 300 ) ;</pre>


<h2><a name="_status____i__inflate__input___output____eof__"> $status = $i-&gt;inflate($input, $output [,$eof]) </a></h2>
Inflates the complete contents of <code>$input</code> and writes the uncompressed
data to <code>$output</code>. The <code>$input</code> and <code>$output</code> parameters can either be
scalars or scalar references.
Returns <code>Z_OK</code> if successful and <code>Z_STREAM_END</code> if the end of the
compressed data has been successfully reached.
If not successful <code>$status</code> will hold the zlib error code.
If the <a href="#consumeinput"><code>ConsumeInput</code></a> option has been set to true when the
<code>Compress::Raw::Zlib::Inflate</code> object is created, the <code>$input</code> parameter
is modified by <code>inflate</code>. On completion it will contain what remains
of the input buffer after inflation. In practice, this means that when
the return status is <code>Z_OK</code> the <code>$input</code> parameter will contain an
empty string, and when the return status is <code>Z_STREAM_END</code> the <code>$input</code>
parameter will contains what (if anything) was stored in the input buffer
after the deflated data stream.
This feature is useful when processing a file format that encapsulates
a compressed data stream (e.g. gzip, zip) and there is useful data
immediately after the deflation stream.
If the <a href="#appendoutput"><code>AppendOutput</code></a> option is set to true in the constructor for
this object, the uncompressed data will be appended to <code>$output</code>. If
it is false, <code>$output</code> will be truncated before any uncompressed data
is written to it.
The <code>$eof</code> parameter needs a bit of explanation.
Prior to version 1.2.0, zlib assumed that there was at least one trailing
byte immediately after the compressed data stream when it was carrying out
decompression. This normally isn't a problem because the majority of zlib
applications guarantee that there will be data directly after the
compressed data stream. For example, both gzip (<a href="http://www.ietf.org/rfc/rfc1950.txt" class="rfc">RFC 1950</a>) and zip both
define trailing data that follows the compressed data stream.
The <code>$eof</code> parameter only needs to be used if all of the following
conditions apply
<ol>
<li>
You are either using a copy of zlib that is older than version 1.2.0 or you
want your application code to be able to run with as many different
versions of zlib as possible.
</li>
<li>
You have set the <a href="#windowbits"><code>WindowBits</code></a> parameter to <code>-MAX_WBITS</code> in the constructor
for this object, i.e. you are uncompressing a raw deflated data stream
(<a href="http://www.ietf.org/rfc/rfc1951.txt" class="rfc">RFC 1951</a>).
</li>
<li>
There is no data immediately after the compressed data stream.
</li>
</ol>
If all of these are the case, then you need to set the <code>$eof</code> parameter
to true on the final call (and only the final call) to <code>$i-&gt;inflate</code>.
If you have built this module with zlib &gt;= 1.2.0, the <code>$eof</code> parameter is
ignored. You can still set it if you want, but it won't be used behind the
scenes.


<h2><a name="_status____i__inflatesync__input_">$status = $i-&gt;inflateSync($input)</a></h2>
This method can be used to attempt to recover good data from a compressed
data stream that is partially corrupt.
It scans <code>$input</code> until it reaches either a full flush point or the
end of the buffer.
If a full flush point is found, <code>Z_OK</code> is returned and <code>$input</code>
will be have all data up to the flush point removed. This data can then be
passed to the <code>$i-&gt;inflate</code> method to be uncompressed.
Any other return code means that a flush point was not found. If more
data is available, <code>inflateSync</code> can be called repeatedly with more
compressed data until the flush point is found.
Note full flush points are not present by default in compressed
data streams. They must have been added explicitly when the data stream
was created by calling <code>Compress::Deflate::flush</code> with <code>Z_FULL_FLUSH</code>.


<h2><a name="_i__dict_adler__">$i-&gt;dict_adler()</a></h2>
Returns the adler32 value for the dictionary.


<h2><a name="_i__crc32__">$i-&gt;crc32()</a></h2>
Returns the crc32 value for the uncompressed data to date.
If the <a href="#crc32"><code>CRC32</code></a> option is not enabled in the constructor for this object,
this method will always return 0;


<h2><a name="_i__adler32__">$i-&gt;adler32()</a></h2>
Returns the adler32 value for the uncompressed data to date.
If the <a href="#adler32"><code>ADLER32</code></a> option is not enabled in the constructor for this object,
this method will always return 0;


<h2><a name="_i__msg__">$i-&gt;msg()</a></h2>
Returns the last error message generated by zlib.


<h2><a name="_i__total_in__">$i-&gt;total_in()</a></h2>
Returns the total number of bytes compressed bytes input to inflate.


<h2><a name="_i__total_out__">$i-&gt;total_out()</a></h2>
Returns the total number of uncompressed bytes output from inflate.


<h2><a name="_d__get_bufsize__">$d-&gt;get_BufSize()</a></h2>
Returns the buffer size used to carry out the decompression.


<h2><a name="example">Example</a></h2>
Here is an example of using <code>inflate</code>.
<pre>
 use strict ;
 use warnings ;
 
 use Compress::Raw::Zlib;
 
 my $x = new Compress::Raw::Zlib::Inflate()
 or die &quot;Cannot create a inflation stream\n&quot; ;
 
 my $input = '' ;
 binmode STDIN;
 binmode STDOUT;
 
 my ($output, $status) ;
 while (read(STDIN, $input, 4096))
 {
 $status = $x-&gt;inflate(\$input, $output) ;
 
 print $output 
 if $status == Z_OK or $status == Z_STREAM_END ;
 
 last if $status != Z_OK ;
 }
 
 die &quot;inflation failed\n&quot;
 unless $status == Z_STREAM_END ;</pre>


<hr />
<h1><a name="checksum_functions">CHECKSUM FUNCTIONS</a></h1>
Two functions are provided by zlib to calculate checksums. For the
Perl interface, the order of the two parameters in both functions has
been reversed. This allows both running checksums and one off
calculations to be done.
<pre>
 $crc = adler32($buffer [,$crc]) ;
 $crc = crc32($buffer [,$crc]) ;</pre>
The buffer parameters can either be a scalar or a scalar reference.
If the $crc parameters is <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlfunc.html#undef"><code>undef</code></a>, the crc value will be reset.
If you have built this module with zlib 1.2.3 or better, two more
CRC-related functions are available.
<pre>
 $crc = adler32_combine($crc1, $crc2, $len2)l
 $crc = crc32_combine($adler1, $adler2, $len2)</pre>
These functions allow checksums to be merged.


<hr />
<h1><a name="accessing_zip_files">ACCESSING ZIP FILES</a></h1>
Although it is possible (with some effort on your part) to use this
module to access .zip files, there is a module on CPAN that will do all
the hard work for you. Check out the <code>Archive::Zip</code> module on CPAN at
<pre>
 <a href="http://www.cpan.org/modules/by-module/Archive/Archive-Zip">http://www.cpan.org/modules/by-module/Archive/Archive-Zip</a>-*.tar.gz</pre>


<hr />
<h1><a name="constants">CONSTANTS</a></h1>
All the zlib constants are automatically imported when you make use
of Compress::Raw::Zlib.


<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/Compress/Zlib.html">the Compress::Zlib manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/IO/Compress/Gzip.html">the IO::Compress::Gzip manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/IO/Uncompress/Gunzip.html">the IO::Uncompress::Gunzip manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/IO/Compress/Deflate.html">the IO::Compress::Deflate manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/IO/Uncompress/Inflate.html">the IO::Uncompress::Inflate manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/IO/Compress/RawDeflate.html">the IO::Compress::RawDeflate manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/IO/Uncompress/RawInflate.html">the IO::Uncompress::RawInflate manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/IO/Compress/Bzip2.html">the IO::Compress::Bzip2 manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/IO/Uncompress/Bunzip2.html">the IO::Uncompress::Bunzip2 manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/IO/Compress/Lzop.html">the IO::Compress::Lzop manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/IO/Uncompress/UnLzop.html">the IO::Uncompress::UnLzop manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/IO/Compress/Lzf.html">the IO::Compress::Lzf manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/IO/Uncompress/UnLzf.html">the IO::Uncompress::UnLzf manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/IO/Uncompress/AnyInflate.html">the IO::Uncompress::AnyInflate manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/IO/Uncompress/AnyUncompress.html">the IO::Uncompress::AnyUncompress manpage</a>
<a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/Compress/Zlib/FAQ.html">Compress::Zlib::FAQ</a>
<a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/File/GlobMapper.html">File::GlobMapper</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/Archive/Zip.html">Archive::Zip</a>,
<a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/Archive/Tar.html">Archive::Tar</a>,
<a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/IO/Zlib.html">IO::Zlib</a>
For <a href="http://www.ietf.org/rfc/rfc1950.txt" class="rfc">RFC 1950</a>, 1951 and 1952 see 
<a href="http://www.faqs.org/rfcs/rfc1950.html">http://www.faqs.org/rfcs/rfc1950.html</a>,
<a href="http://www.faqs.org/rfcs/rfc1951.html">http://www.faqs.org/rfcs/rfc1951.html</a> and
<a href="http://www.faqs.org/rfcs/rfc1952.html">http://www.faqs.org/rfcs/rfc1952.html</a>
The zlib compression library was written by Jean-loup Gailly
<a href="mailto:gzip@prep.ai.mit.edu">gzip@prep.ai.mit.edu</a> and Mark Adler <a href="mailto:madler@alumni.caltech.edu">madler@alumni.caltech.edu</a>.
The primary site for the zlib compression library is
<a href="http://www.zlib.org">http://www.zlib.org</a>.
The primary site for gzip is <a href="http://www.gzip.org">http://www.gzip.org</a>.


<hr />
<h1><a name="author">AUTHOR</a></h1>
This module was written by Paul Marquess, <a href="mailto:pmqs@cpan.org">pmqs@cpan.org</a>.


<hr />
<h1><a name="modification_history">MODIFICATION HISTORY</a></h1>
See the Changes file.


<hr />
<h1><a name="copyright_and_license">COPYRIGHT AND LICENSE</a></h1>
Copyright (c) 2005-2007 Paul Marquess. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="block" style="background-color: #cccccc" valign="middle">
<big>&nbsp;Compress::Raw::Zlib - Low-Level Interface to zlib compression library</big>
</td></tr>
</table>

</body>

</html>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de