<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>liboggz: oggz_table.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>oggz_table.h File Reference</h1>
<p>A lookup table.
<a href="#_details">More...</a></p>
<p><a href="oggz__table_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72c5d21d2254089d192176e1c310b023"></a><!-- doxytag: member="oggz_table.h::OggzTable" ref="a72c5d21d2254089d192176e1c310b023" args="" -->
typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A table of key-value pairs. <br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__table_8h.html#a40772505443484de93526882c48f0dd8">oggz_table_new</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a new OggzTable. <a href="#a40772505443484de93526882c48f0dd8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__table_8h.html#a989e307feecf2adc2ebe905c067051c4">oggz_table_delete</a> (<a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> *table)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete an OggzTable. <a href="#a989e307feecf2adc2ebe905c067051c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__table_8h.html#adbcdb0cdf6e8392c78956e911cbf6634">oggz_table_insert</a> (<a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> *table, long key, void *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Insert an element into a table. <a href="#adbcdb0cdf6e8392c78956e911cbf6634"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__table_8h.html#ac137e535f1da63ee52266b47f114020f">oggz_table_remove</a> (<a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> *table, long key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the element of an OggzTable indexed by a given key. <a href="#ac137e535f1da63ee52266b47f114020f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__table_8h.html#a92ea55bffd5657be29cf1972f33364e3">oggz_table_lookup</a> (<a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> *table, long key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the element of an OggzTable indexed by a given key. <a href="#a92ea55bffd5657be29cf1972f33364e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__table_8h.html#a62db2037df45db88a75b89b8a8ac7766">oggz_table_size</a> (<a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> *table)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the number of elements in an OggzTable. <a href="#a62db2037df45db88a75b89b8a8ac7766"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__table_8h.html#a285c3cbdb46e9b8c2a831728182856f1">oggz_table_nth</a> (<a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> *table, int n, long *key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the nth element of an OggzTable, and optionally its key. <a href="#a285c3cbdb46e9b8c2a831728182856f1"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A lookup table. </p>
<p>OggzTable is provided for convenience to allow the storage of serialno-specific data. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a989e307feecf2adc2ebe905c067051c4"></a><!-- doxytag: member="oggz_table.h::oggz_table_delete" ref="a989e307feecf2adc2ebe905c067051c4" args="(OggzTable *table)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oggz_table_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * </td>
<td class="paramname"> <em>table</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete an OggzTable. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>An OggzTable </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adbcdb0cdf6e8392c78956e911cbf6634"></a><!-- doxytag: member="oggz_table.h::oggz_table_insert" ref="adbcdb0cdf6e8392c78956e911cbf6634" args="(OggzTable *table, long key, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* oggz_table_insert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * </td>
<td class="paramname"> <em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Insert an element into a table. </p>
<p>If a previous value existed for this key, it is overwritten with the new data element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>An OggzTable </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key to access this data element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The new element to add </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>If the element was successfully added </td></tr>
<tr><td valign="top"></td><td valign="top"><em>NULL</em> </td><td>If adding the element failed due to a realloc() error </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a92ea55bffd5657be29cf1972f33364e3"></a><!-- doxytag: member="oggz_table.h::oggz_table_lookup" ref="a92ea55bffd5657be29cf1972f33364e3" args="(OggzTable *table, long key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* oggz_table_lookup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * </td>
<td class="paramname"> <em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the element of an OggzTable indexed by a given key. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>An OggzTable </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>a key </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The element indexed by <em>key</em> </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>NULL</em> </td><td><em>table</em> is undefined, or no element is indexed by <em>key</em> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a40772505443484de93526882c48f0dd8"></a><!-- doxytag: member="oggz_table.h::oggz_table_new" ref="a40772505443484de93526882c48f0dd8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a>* oggz_table_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instantiate a new OggzTable. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new OggzTable </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>NULL</em> </td><td>Could not allocate memory for table </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a285c3cbdb46e9b8c2a831728182856f1"></a><!-- doxytag: member="oggz_table.h::oggz_table_nth" ref="a285c3cbdb46e9b8c2a831728182856f1" args="(OggzTable *table, int n, long *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* oggz_table_nth </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * </td>
<td class="paramname"> <em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long * </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the nth element of an OggzTable, and optionally its key. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>An OggzTable </td></tr>
<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>An index into the <em>table</em> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Return pointer for key corresponding to nth data element of <em>table</em>. Ignored if NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The nth data element of <em>table</em> </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>NULL</em> </td><td><em>table</em> is undefined, or <em>n</em> is out of range </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac137e535f1da63ee52266b47f114020f"></a><!-- doxytag: member="oggz_table.h::oggz_table_remove" ref="ac137e535f1da63ee52266b47f114020f" args="(OggzTable *table, long key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_table_remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * </td>
<td class="paramname"> <em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the element of an OggzTable indexed by a given key. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>An OggzTable </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>a key </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>Success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>-1</em> </td><td>Not found </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a62db2037df45db88a75b89b8a8ac7766"></a><!-- doxytag: member="oggz_table.h::oggz_table_size" ref="a62db2037df45db88a75b89b8a8ac7766" args="(OggzTable *table)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_table_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * </td>
<td class="paramname"> <em>table</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query the number of elements in an OggzTable. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>An OggzTable </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of elements in <em>table</em> </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Apr 24 09:13:55 2010 for liboggz by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>