1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>CXReadUncompLZ</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXReadUncompLZ</h1>
15
16<h2>Syntax</h2>
17<DL><DD><PRE class="construction">
18#include &lt;revolution/cx/CXStreamingUncompression.h&gt;
19
20s32 CXReadUncompLZ( <A href="CXUncompContextLZ.html">CXUncompContextLZ</A> *context,
21                     const void*       data,
22                     u32               len );
23</PRE></dd></dl>
24
25<h2>Arguments</h2>
26<TABLE class="arguments" border="1">
27  <TBODY>
28    <TR>
29<TH>context</TH>
30<TD>Pointer to the context structure for the uncompression of LZ77-compressed data.</TD>
31    </TR>
32    <TR>
33<TH>data</TH>
34<TD>Pointer to the next data in the file being decompressed.</TD>
35    </TR>
36    <TR>
37<TH>len</TH>
38<TD>Size of the data provided in the second argument.</TD>
39    </TR>
40  </TBODY>
41</TABLE>
42
43<h2>Return Values</h2>
44<p>Returns a positive value if data remains to be uncompressed, and a negative error code if an error has occurred.<BR>returns 0 of all data was successfully decompressed.</p>
45<TABLE class="arguments" border="1">
46  <TBODY>
47    <TR>
48<TH>Positive integer</TH>
49<TD>Number of bytes not yet decompressed.</TD>
50    </TR>
51    <TR>
52<TH>CX_ERR_SUCCESS</TH>
53<TD>Ended normally (==0).</TD>
54    </TR>
55    <TR>
56<TH>CX_ERR_UNSUPPORTED</TH>
57<TD>Unsupported compression data type.</TD>
58    </TR>
59    <TR>
60<TH>CX_ERR_SRC_SHORTAGE</TH>
61<TD>Source data size is too small.</TD>
62    </TR>
63    <TR>
64<TH>CX_ERR_SRC_REMAINDER</TH>
65<TD>Source data size is too large.</TD>
66    </TR>
67    <TR>
68<TH>CX_ERR_ILLEGAL_TABLE</TH>
69<TD>The Huffman table contains mistakes.</TD>
70    </TR>
71  </TBODY>
72</TABLE>
73
74<H2>Description</H2>
75<P>Performs streaming uncompression of LZ77-compressed data, doing just the data size given; copies the data to the buffer specified by the <A href="CXInitUncompContextLZ.html"><CODE>CXInitUncompContextLZ</CODE></A> function. Compared to <A href="CXUncompressLZ.html"><CODE>CXUncompressLZ</CODE></A>, which decompresses all data at once, this function is slow.</P>
76
77<h2>See Also</h2>
78<p class="reference">
79<A href="CXGetUncompressedSize.html">CXGetUncompressedSize</A>,
80<A href="CXUncompressLZ.html">CXUncompressLZ</A>,
81<A href="CXSecureUncompressLZ.html">CXSecureUncompressLZ</A>,
82<A href="CXInitUncompContextLZ.html">CXInitUncompContextLZ</A>,
83<A href="CXIsFinishedUncompLZ.html">CXIsFinishedUncompLZ</A>,
84<A href="CXCompressLZ.html">CXCompressLZ</A>,
85<A href="CXCompressLZEX.html">CXCompressLZEx</A>,
86<A href="../tools/ntcompress.html">ntcompress</A>
87</p>
88
89<H2>Revision History</H2>
90<P>
912007/09/03 Corrected error in <B>See Also</B>, adding a link for <CODE>CXCompressLZEx</CODE>.<BR>2006/07/06 Initial version.<BR>
92</P>
93
94<hr><p>CONFIDENTIAL</p></body>
95</html>
96