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">
14u32 CompressLZ(
15     const u8 * srcp,
16     u32             size,
17     u8 * dstp,
18     void * work
19);
20</pre>
21    </div>
22<h2>Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>in</td>
34<th>srcp</th>
35<td>Pointer to compression source data.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>size</th>
40<td>Compression source data size.</td>
41        </tr>
42        <tr>
43<td>out</td>
44<th>dstp</th>
45<td>Pointer to compression target data (requires a buffer larger than the compression source data).</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>work</th>
50<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>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<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>
55<h2>Description</h2>
56    <div class="section">
57<p>Carries out LZ77 compression.</p><p>
58Argument values must adhere to the following restrictions:
59        <ul><li>
60The address for <B>srcp</B> must be aligned to 2 bytes.
61          </li><li>
62The value of <B>size </B>must be larger than 4.
63          </li></ul></p></div>
64<h2>Revision History</h2>
65    <div class="section">
66      <dl class="history">
67        <dt>2011/04/06</dt>
68<dd>Added text about the restriction on argument values.<br />
69        </dd>
70        <dt>2010/11/10</dt>
71<dd>Initial version.<br />
72        </dd>
73      </dl>
74    </div>
75  <hr><p>CONFIDENTIAL</p></body>
76</html>
77