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>CXSecureUncompressLH</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXSecureUncompressLH</h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;revolution/cx.h&gt;</CODE><BR>
20  <BR>
21  <CODE>s32 CXSecureUncompressLH( const void* srcp, u32 srcSize, void* destp, void* work );</CODE></dd>
22</dl>
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1">
25  <TBODY>
26    <TR>
27<TH>srcp</TH>
28<TD>Source address where data compressed in LH format 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 the data is expanded.</TD>
37    </TR>
38    <TR>
39<TH>work</TH>
40<TD>Work buffer required for data decompression. The size given by <CODE>CX_UNCOMPRESS_LH_WORK_SIZE</CODE> is required.</TD>
41    </TR>
42  </TBODY>
43</TABLE>
44
45<h2>Return Values</h2>
46<TABLE class="arguments" border="1">
47  <TBODY>
48    <TR>
49<TH>CX_ERR_SUCCESS</TH>
50<TD>Successful end.</TD>
51    </TR>
52    <TR>
53<TH>CX_ERR_UNSUPPORTED</TH>
54<TD>Unsupported compression data type.</TD>
55    </TR>
56    <TR>
57<TH>CX_ERR_SRC_SHORTAGE</TH>
58<TD>Source data size is too small.</TD>
59    </TR>
60    <TR>
61<TH>CX_ERR_SRC_REMAINDER</TH>
62<TD>Source data size is too large.</TD>
63    </TR>
64    <TR>
65<TH>CX_ERR_DEST_OVERRUN</TH>
66<TD>Overrun in the decompression buffer.</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>Decompresses LH-format-compressed data and writes the data to the specified region of memory. Align the source address to a 4-byte boundary.</P>
77
78<P>
79To perform streaming expansion of data, use the <A href="CXReadUncompLH.html"><CODE>CXReadUncompLH</CODE></A> function.
80</P>
81
82<h2>See Also</h2>
83<p><A href="CXGetUncompressedSize.html"><CODE>CXGetUncompressedSize</CODE></A><BR> <A href="CXUncompressLH.html"><CODE>CXUncompressLH</CODE></A><BR> <A href="CXInitUncompContextLH.html"><CODE>CXInitUncompContextLH</CODE></A><BR> <A href="CXReadUncompLH.html"><CODE>CXReadUncompLH</CODE></A><BR> <A href="CXIsFinishedUncompLH.html"><CODE>CXIsFinishedUncompLH</CODE></A><BR> <A href="../tools/ntcompress.html"><CODE>ntrompress</CODE></A></p>
84
85<H2>Revision History</H2>
86<P>
872009/01/28 Added a description of parameters.<BR> 2007/11/01 Initial version.
88</P>
89<hr><p>CONFIDENTIAL</p></body>
90</html>
91