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>CXSecureUncompressLZ</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXSecureUncompressLZ</h1>
15
16<h2>Syntax</h2>
17<DL><DD><PRE class="construction">
18#include &lt;revolution/cx.h&gt;
19
20s32 CXSecureUncompressLZ( const void *srcp, u32 srcSize, void *destp );
21</PRE></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1">
25  <TBODY>
26    <TR>
27<TH>srcp</TH>
28<TD>Source address where the LZ77 compressed data is stored</TD>
29    </TR>
30    <TR>
31<TH>srcSize</TH>
32<TD>Source data size</TD>
33    </TR>
34    <TR>
35<TH>destp</TH>
36<TD>Destination address where data is expanded</TD>
37    </TR>
38  </TBODY>
39</TABLE>
40
41<h2>Return Values</h2>
42<TABLE class="arguments" border="1">
43  <TBODY>
44    <TR>
45<TH>CX_ERR_SUCCESS</TH>
46<TD>Successful end</TD>
47    </TR>
48    <TR>
49<TH>CX_ERR_UNSUPPORTED</TH>
50<TD>Unsupported compression data type.</TD>
51    </TR>
52    <TR>
53<TH>CX_ERR_SRC_SHORTAGE</TH>
54<TD>Source data size is too small.</TD>
55    </TR>
56    <TR>
57<TH>CX_ERR_SRC_REMAINDER</TH>
58<TD>Source data size is too large.</TD>
59    </TR>
60    <TR>
61<TH>CX_ERR_DEST_OVERRUN</TH>
62<TD>The expansion destination buffer will be exceeded (buffer overrun).</TD>
63    </TR>
64  </TBODY>
65</TABLE>
66
67<H2>Description</H2>
68<P>This function decompresses LZ77-compressed data and writes the data to the specified region of memory.<BR>Align the source address to a 4-byte boundary.</P>
69
70<P>
71To perform streaming expansion of data, use the <A href="CXReadUncompLZ.html"><CODE>CXReadUncompLZ</CODE></A> function.
72</P>
73
74<h2>See Also</h2>
75<p class="reference">
76<A href="CXGetUncompressedSize.html">CXGetUncompressedSize</A>,
77<A href="CXUncompressLZ.html">CXUncompressLZ</A>,
78<A href="CXInitUncompContextLZ.html">CXInitUncompContextLZ</A>,
79<A href="CXReadUncompLZ.html">CXReadUncompLZ</A>,
80<A href="CXIsFinishedUncompLZ.html">CXIsFinishedUncompLZ</A>,
81<A href="CXCompressLZ.html">CXCompressLZ</A>,
82<A href="CXCompressLZEX.html">CXCompressLZEx</A>,
83<A href="../tools/ntcompress.html">ntcompress</A>
84</p>
85
86<H2>Revision History</H2>
87<P>
882007/09/03 Corrected error in the See Also section. Added link to <CODE>CXCompressLZEx</CODE> in See Also section.<BR>2007/05/24 Initial version.<BR>
89</P>
90
91<hr><p>CONFIDENTIAL</p></body>
92</html>
93