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>CXGetCompressionHeader</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXGetCompressionHeader</h1>
15
16<h2>Syntax</h2>
17<DL><DD><PRE class="construction">
18#include &lt;revolution/cx.h&gt;
19
20CXCompressionHeader CXGetCompressionHeader( const void* srcp );
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 compressed data is stored</TD>
29    </TR>
30  </TBODY>
31</TABLE>
32
33<h2>Return Values</h2>
34<p>Gets the header information of the compressed data.</p>
35
36<H2>Description</H2>
37<P>This function reads the first 8 bytes of the compressed data and gets the header information of the compressed data.</P>
38<P>It is compatible with all compression formats supported by the CX library.</P>
39<P>The <A href="CXCompressionHeader.html"><CODE>CXCompressionHeader</CODE></A> structure of the returned value is used to initialize the context for expansion with the <A href="CXInitUncompContextRL.html"><CODE>CXInitUncompContextRL</CODE></A>, <A href="CXInitUncompContextLZ.html"><CODE>CXInitUncompContextLZ</CODE></A>, and <A href="CXInitUncompContextHuffman.html"><CODE>CXInitUncompContextHuffman</CODE></A> functions.</P>
40<h2>Internal Operation</h2>
41<P>Reads the header in the first 8 bytes of data, converts the data's endian method and returns the correct header information.</P>
42
43<h2>See Also</h2>
44<p class="reference">
45<A href="CXUncompressLZ.html">CXUncompressLZ</A>,
46<A href="CXUncompressHuffman.html">CXUncompressHuffman</A>,
47<A href="CXUncompressRL.html">CXUncompressRL</A>,
48<A href="CXUnfilterDiff.html">CXUnfilterDiff</A>,
49<A href="CXGetUncompressedSize.html">CXGetUncompressedSize</A>
50</p>
51
52<H2>Revision History</H2>
53<P>
542007/09/03 Added links to the functions in Description. Corrected a typo.<BR>2006/09/12 Changed the referenced header size to 8 bytes due to expansion in the file size that can be handled.<BR>2006/07/06 Initial version.<BR>
55</P>
56
57<hr><p>CONFIDENTIAL</p></body>
58</html>
59