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>CXReadUncompLH</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXReadUncompLH</h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19  <PRE><CODE>#include &lt;revolution/cx/CXStreamingUncompression.h&gt;</CODE><BR>
20
21<CODE>s32 CXReadUncompLH( <A href="CXUncompContextLH.html">CXUncompContextLH</A> *context,
22                     const void*       data,
23                     u32               len );</CODE></PRE>
24  </dd>
25</dl>
26<h2>Arguments</h2>
27<TABLE class="arguments" border="1">
28  <TBODY>
29    <TR>
30<TH>context</TH>
31<TD>Pointer to the context structure for decompression of LH-compressed data.</TD>
32    </TR>
33    <TR>
34<TH>data</TH>
35<TD>Pointer to the next data in the file being decompressed.</TD>
36    </TR>
37    <TR>
38<TH>len</TH>
39<TD>Size of the data provided in the 2nd argument.</TD>
40    </TR>
41  </TBODY>
42</TABLE>
43
44<h2>Return Values</h2>
45<p>Returns a positive value if data remains to be uncompressed, and returns a negative error code if an error has occurred.<BR>If all data was successfully decompressed, the function returns 0.</p>
46<TABLE class="arguments" border="1">
47  <TBODY>
48    <TR>
49<TH>Positive integer</TH>
50<TD>Number of bytes not yet decompressed.</TD>
51    </TR>
52    <TR>
53<TH>CX_ERR_SUCCESS</TH>
54<TD>Ended normally (==0).</TD>
55    </TR>
56    <TR>
57<TH>CX_ERR_UNSUPPORTED</TH>
58<TD>Unsupported compression data type.</TD>
59    </TR>
60    <TR>
61<TH>CX_ERR_SRC_SHORTAGE</TH>
62<TD>Source data size is too small.</TD>
63    </TR>
64    <TR>
65<TH>CX_ERR_SRC_REMAINDER</TH>
66<TD>Source data size is too large.</TD>
67    </TR>
68    <TR>
69<TH>CX_ERR_ILLEGAL_TABLE</TH>
70<TD>The Huffman table contains mistakes.</TD>
71    </TR>
72  </TBODY>
73</TABLE>
74
75<H2>Description</H2>
76<P>Performs streaming uncompression of LH-compressed data, processing just the data size given, and copies it to the buffer specified by the <A href="CXInitUncompContextLH.html"><CODE>CXInitUncompContextLH</CODE></A> function. Compared to the <A href="CXUncompressLH.html"><CODE>CXUncompressLH</CODE></A> function, which decompresses all data at once, this function is slow.</P>
77
78<h2>See Also</h2>
79<p><CODE><A href="CXGetUncompressedSize.html">CXGetUncompressedSize</A><BR><A href="CXUncompressLH.html">CXUncompressLH</A><BR><A href="CXSecureUncompressLH.html">CXSecureUncompressLH</A><BR><A href="CXInitUncompContextLH.html">CXInitUncompContextLH</A><BR><A href="CXIsFinishedUncompLH.html">CXIsFinishedUncompLH</A><BR><A href="../tools/ntcompress.html">ntrompress</A></CODE></p>
80
81<H2>Revision History</H2>
82<P>2007/11/01 Initial version.</P>
83<hr><p>CONFIDENTIAL</p></body>
84</html>
85