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