1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../css/manpage.css" type="text/css" />
7<title>CompressLZ</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/cx/Overview.html">cx</a>::CompressLZ</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/cx.h&gt;
14
15<a href="../../nn_types/u32.html">u32</a> CompressLZ(
16     const <a href="../../nn_types/u8.html">u8</a> * srcp,
17     <a href="../../nn_types/u32.html">u32</a> size,
18     <a href="../../nn_types/u8.html">u8</a> * dstp,
19     void * work
20);
21</pre>
22    </div>
23<h2>Parameters</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29<th>Name</th>
30<td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34<td>in</td>
35<th><CODE>srcp</CODE></th>
36<td>Pointer to compression source data.</td>
37        </tr>
38        <tr>
39<td>in</td>
40<th><CODE>size</CODE></th>
41<td>Compression source data size.</td>
42        </tr>
43        <tr>
44<td>out</td>
45<th><CODE>dstp</CODE></th>
46<td>Pointer to compression target data (requires a buffer larger than the compression source data).</td>
47        </tr>
48        <tr>
49<td>in</td>
50<th><CODE>work</CODE></th>
51<td>Temporary buffer to use for compression (requires a region of <CODE><a href="../../nn/cx/LZ_COMPRESS_WORK_SIZE.html">nn::cx::LZ_COMPRESS_WORK_SIZE</a></CODE> bytes).</td>
52        </tr> </table>
53    </div>
54<h2>Return Values</h2>
55<div class="section">Returns the size of the compressed data. If the compressed data is larger than the original data, compression is terminated and <CODE>0</CODE> is returned. </div>
56<h2>Description</h2>
57    <div class="section">
58<p>Carries out LZ77 compression.</p><p>
59Argument values must adhere to the following restrictions:
60        <ul><li>
61The address for <SPAN class="argument">srcp</SPAN> must be aligned to 2 bytes.
62          </li><li>
63The value of <SPAN class="argument">size</SPAN> must be larger than 4.
64          </li></ul></p></div>
65<h2>Revision History</h2>
66    <div class="section">
67      <dl class="history">
68        <dt>2011/04/06</dt>
69<dd>Added text about the restriction on argument values.<br />
70        </dd>
71        <dt>2010/11/10</dt>
72<dd>Initial version.<br />
73        </dd>
74      </dl>
75    </div>
76  <hr><p>CONFIDENTIAL</p></body>
77</html>