<!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>libcollection: TOOLS interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libcollection <span id="projectnumber">0.1.3</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">TOOLS interface</div> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcol__serial__data.html">col_serial_data</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure is used to incrementaly serialize collection. <a href="structcol__serial__data.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0e0ad5517f64e55ed7dfa19c83e1c9ee"></a><!-- doxytag: member="tools::COL_TYPE_NAME_STRING" ref="ga0e0ad5517f64e55ed7dfa19c83e1c9ee" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga0e0ad5517f64e55ed7dfa19c83e1c9ee">COL_TYPE_NAME_STRING</a>   "string"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name used for string type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga535c8a542a2406b225e114cae5b480de"></a><!-- doxytag: member="tools::COL_TYPE_NAME_BINARY" ref="ga535c8a542a2406b225e114cae5b480de" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga535c8a542a2406b225e114cae5b480de">COL_TYPE_NAME_BINARY</a>   "bin"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name used for binary type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae670552734d2aff1b899d4d49af8bd41"></a><!-- doxytag: member="tools::COL_TYPE_NAME_INTEGER" ref="gae670552734d2aff1b899d4d49af8bd41" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gae670552734d2aff1b899d4d49af8bd41">COL_TYPE_NAME_INTEGER</a>   "int"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name used for integer type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga026c91e1eb32561c32a36fa065dd2eaa"></a><!-- doxytag: member="tools::COL_TYPE_NAME_UNSIGNED" ref="ga026c91e1eb32561c32a36fa065dd2eaa" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga026c91e1eb32561c32a36fa065dd2eaa">COL_TYPE_NAME_UNSIGNED</a>   "uint"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name used for unsigned integer type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0129f186169c5af7c54248bcfda1eb50"></a><!-- doxytag: member="tools::COL_TYPE_NAME_LONG" ref="ga0129f186169c5af7c54248bcfda1eb50" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga0129f186169c5af7c54248bcfda1eb50">COL_TYPE_NAME_LONG</a>   "long"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name used for long type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga09039181b49928b8351f21bdeecc73a6"></a><!-- doxytag: member="tools::COL_TYPE_NAME_ULONG" ref="ga09039181b49928b8351f21bdeecc73a6" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga09039181b49928b8351f21bdeecc73a6">COL_TYPE_NAME_ULONG</a>   "ulong"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name used for unsigned long type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga565e9565049465fa8e91e4b683400251"></a><!-- doxytag: member="tools::COL_TYPE_NAME_DOUBLE" ref="ga565e9565049465fa8e91e4b683400251" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga565e9565049465fa8e91e4b683400251">COL_TYPE_NAME_DOUBLE</a>   "double"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name used for floating point type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaeb3b657ae179826aab5959b158da29d3"></a><!-- doxytag: member="tools::COL_TYPE_NAME_BOOL" ref="gaeb3b657ae179826aab5959b158da29d3" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gaeb3b657ae179826aab5959b158da29d3">COL_TYPE_NAME_BOOL</a>   "bool"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name used for boolean type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga30dd9bac5b510f5e5e629ceb2040456f"></a><!-- doxytag: member="tools::COL_TYPE_NAME_UNKNOWN" ref="ga30dd9bac5b510f5e5e629ceb2040456f" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga30dd9bac5b510f5e5e629ceb2040456f">COL_TYPE_NAME_UNKNOWN</a>   "unknown"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name used for unknown type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga357f6fd9a05f4826029da1dbc1d01337"></a><!-- doxytag: member="tools::TEXT_COLLECTION" ref="ga357f6fd9a05f4826029da1dbc1d01337" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga357f6fd9a05f4826029da1dbc1d01337">TEXT_COLLECTION</a>   "SET"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Literal used in the default serialization. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6610313081dc9823ba26d6828029ea9a"></a><!-- doxytag: member="tools::TEXT_COLLEN" ref="ga6610313081dc9823ba26d6828029ea9a" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga6610313081dc9823ba26d6828029ea9a">TEXT_COLLEN</a>   3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Length of the <a class="el" href="group__tools.html#ga357f6fd9a05f4826029da1dbc1d01337">TEXT_COLLECTION</a> literal. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad51ded0bbd705f02f73fc60c0b721ced"></a><!-- doxytag: member="tools::BLOCK_SIZE" ref="gad51ded0bbd705f02f73fc60c0b721ced" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gad51ded0bbd705f02f73fc60c0b721ced">BLOCK_SIZE</a>   1024</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The data will be allocated in BLOCK_SIZE blocks during serialization. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga429e48fbb0d0004cd2adb958640f729e">col_get_data_len</a> (int type, int length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate the potential size of the item. <a href="#ga429e48fbb0d0004cd2adb958640f729e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gaab66465a7ac06cc7fe761e1194a48497">col_grow_buffer</a> (struct <a class="el" href="structcol__serial__data.html">col_serial_data</a> *buf_data, int len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Grow serialization buffer. <a href="#gaab66465a7ac06cc7fe761e1194a48497"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga9e1ae48ab8f8da6b8f007d8240bedfb2">col_put_marker</a> (struct <a class="el" href="structcol__serial__data.html">col_serial_data</a> *buf_data, const void *data, int len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add special data to the serialization output. <a href="#ga9e1ae48ab8f8da6b8f007d8240bedfb2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga87ed98ae77485302291437f3dc128187">col_serialize</a> (const char *property_in, int property_len_in, int type, void *data_in, int length_in, void *custom_data, int *dummy)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serialization of data callback. <a href="#ga87ed98ae77485302291437f3dc128187"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gadf0726d3ee6a8d0f2af491cf368d94db">col_debug_handle</a> (const char *property, int property_len, int type, void *data, int length, void *custom_data, int *dummy)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Debug property callback. <a href="#gadf0726d3ee6a8d0f2af491cf368d94db"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#ga2d3a13e09bd117cb6aeefc7da9297cfd">col_debug_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to debug an item. <a href="#ga2d3a13e09bd117cb6aeefc7da9297cfd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gaa00d6122b50463e296c9ba519906cc53">col_debug_collection</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *handle, int flag)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print collection for debugging purposes. <a href="#gaa00d6122b50463e296c9ba519906cc53"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gafb7c365e36ed6be8006337670021cb94">col_print_collection</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print collection data. <a href="#gafb7c365e36ed6be8006337670021cb94"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gaf30b1eefba0461b31f240638d258de1a">col_print_collection2</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print collection data. <a href="#gaf30b1eefba0461b31f240638d258de1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gafa3625bac175cf5c7e42669d07071538">col_print_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *handle, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find and print one property. <a href="#gafa3625bac175cf5c7e42669d07071538"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gae8a801a46f64c5f673b82331661233b3">col_collection_to_list</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *handle, int *size, int *error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert collection to the array of properties. <a href="#gae8a801a46f64c5f673b82331661233b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tools.html#gace253d7f83008def0574eed30df91ae2">col_free_property_list</a> (char **str_list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free list of properties. <a href="#gace253d7f83008def0574eed30df91ae2"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Additional functions retaed to tracing, printing, debugging and serializaing collections.</p>
<p>Functions in this module are more a sample implementation than a part of the interface. There is a chance they will change over time. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gae8a801a46f64c5f673b82331661233b3"></a><!-- doxytag: member="collection_tools.h::col_collection_to_list" ref="gae8a801a46f64c5f673b82331661233b3" args="(struct collection_item *handle, int *size, int *error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char** col_collection_to_list </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert collection to the array of properties. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Collection to convert. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Will receive the number of the strings in the array. Can be NULL if caller is not interested in the size of the array. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>Will receive error value if any. Can be NULL if the caller does not care about error codes.<ul>
<li>0 - Success.</li>
<li>ENOMEM - No memory.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>List of strings that constitute the properties in the collection. Collection name is not included. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa00d6122b50463e296c9ba519906cc53"></a><!-- doxytag: member="collection_tools.h::col_debug_collection" ref="gaa00d6122b50463e296c9ba519906cc53" args="(struct collection_item *handle, int flag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_debug_collection </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print collection for debugging purposes. </p>
<p>Prints collection internals.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Collection to debug. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flag</td><td>See traverse flags.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Success. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="gadf0726d3ee6a8d0f2af491cf368d94db"></a><!-- doxytag: member="collection_tools.h::col_debug_handle" ref="gadf0726d3ee6a8d0f2af491cf368d94db" args="(const char *property, int property_len, int type, void *data, int length, void *custom_data, int *dummy)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_debug_handle </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>property_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>custom_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>dummy</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Debug property callback. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">property</td><td>Property to debug. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">property_len</td><td>Length of the property to debug. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of the value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Value to serialize. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>Length of the value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">custom_data</td><td>State data passed to the callback. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dummy</td><td>Not used. It is here because the callback needs to comply to the functions signature.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Success. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2d3a13e09bd117cb6aeefc7da9297cfd"></a><!-- doxytag: member="collection_tools.h::col_debug_item" ref="ga2d3a13e09bd117cb6aeefc7da9297cfd" args="(struct collection_item *item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_debug_item </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function to debug an item. </p>
<p>Prints item internals.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">item</td><td>Item to print.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Success. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="gace253d7f83008def0574eed30df91ae2"></a><!-- doxytag: member="collection_tools.h::col_free_property_list" ref="gace253d7f83008def0574eed30df91ae2" args="(char **str_list)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void col_free_property_list </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>str_list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free list of properties. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str_list</td><td>List to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga429e48fbb0d0004cd2adb958640f729e"></a><!-- doxytag: member="collection_tools.h::col_get_data_len" ref="ga429e48fbb0d0004cd2adb958640f729e" args="(int type, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_get_data_len </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calculate the potential size of the item. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of the value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>Length of the value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Maximum length the value would occupy when serialized. </dd></dl>
</div>
</div>
<a class="anchor" id="gaab66465a7ac06cc7fe761e1194a48497"></a><!-- doxytag: member="collection_tools.h::col_grow_buffer" ref="gaab66465a7ac06cc7fe761e1194a48497" args="(struct col_serial_data *buf_data, int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_grow_buffer </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcol__serial__data.html">col_serial_data</a> * </td>
<td class="paramname"><em>buf_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Grow serialization buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buf_data</td><td>Serialization object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>For how much the serialization storage should be incrementally increased.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Success. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="gafb7c365e36ed6be8006337670021cb94"></a><!-- doxytag: member="collection_tools.h::col_print_collection" ref="gafb7c365e36ed6be8006337670021cb94" args="(struct collection_item *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_print_collection </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print collection data. </p>
<p>Prints collection data. Uses traverse function to iterate through the collection.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Collection to print.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Success. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="gaf30b1eefba0461b31f240638d258de1a"></a><!-- doxytag: member="collection_tools.h::col_print_collection2" ref="gaf30b1eefba0461b31f240638d258de1a" args="(struct collection_item *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_print_collection2 </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print collection data. </p>
<p>Prints collection data. Uses iterator to process the collection.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Collection to print.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Success. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="gafa3625bac175cf5c7e42669d07071538"></a><!-- doxytag: member="collection_tools.h::col_print_item" ref="gafa3625bac175cf5c7e42669d07071538" args="(struct collection_item *handle, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_print_item </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find and print one property. </p>
<p>Prints item data.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Collection to search. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Item to find and print.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Success. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="ga9e1ae48ab8f8da6b8f007d8240bedfb2"></a><!-- doxytag: member="collection_tools.h::col_put_marker" ref="ga9e1ae48ab8f8da6b8f007d8240bedfb2" args="(struct col_serial_data *buf_data, const void *data, int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_put_marker </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcol__serial__data.html">col_serial_data</a> * </td>
<td class="paramname"><em>buf_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add special data to the serialization output. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buf_data</td><td>Serialization object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to special data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Length of the data to insert.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Success. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="ga87ed98ae77485302291437f3dc128187"></a><!-- doxytag: member="collection_tools.h::col_serialize" ref="ga87ed98ae77485302291437f3dc128187" args="(const char *property_in, int property_len_in, int type, void *data_in, int length_in, void *custom_data, int *dummy)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_serialize </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>property_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>property_len_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>length_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>custom_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>dummy</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Serialization of data callback. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">property_in</td><td>Property to serialize. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">property_len_in</td><td>Length of the property to serialize. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of the value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data_in</td><td>Value to serialize. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length_in</td><td>Length of the value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">custom_data</td><td>State data passed to callback. It is actually a serialization object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dummy</td><td>Not used. It is here because the callback needs to comply to the functions signature.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Success. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Sep 15 2011 for libcollection by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
