<!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: Item modification wrappers</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Item modification wrappers</div> </div>
<div class="ingroups"><a class="el" href="group__getitem.html">Item management</a></div></div>
<div class="contents">
<table class="memberdecls">
<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__modwrap.html#gafe79b2532c922391868556c004d8f7fa">col_modify_item_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item, const char *property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify item property. <a href="#gafe79b2532c922391868556c004d8f7fa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__modwrap.html#ga525e5ce9400ec5870681797f890eb14e">col_modify_str_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item, const char *property, const char *string, int length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify item value to be a string. <a href="#ga525e5ce9400ec5870681797f890eb14e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__modwrap.html#ga7d200551ebbe59a93f7d8007641f9a6f">col_modify_binary_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item, const char *property, void *binary_data, int length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify item value to be a binary blob. <a href="#ga7d200551ebbe59a93f7d8007641f9a6f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__modwrap.html#gaa4319ad401a8d27bbd3380bc900889f4">col_modify_bool_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item, const char *property, unsigned char logical)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify item value to be a Boolean. <a href="#gaa4319ad401a8d27bbd3380bc900889f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__modwrap.html#gabe2cb392565b7fc6d8f4fa8fc051390d">col_modify_int_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item, const char *property, int32_t number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify item value to be an integer. <a href="#gabe2cb392565b7fc6d8f4fa8fc051390d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__modwrap.html#gab21e6db9ca7cb8bb4d795702dda30c40">col_modify_long_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item, const char *property, int64_t number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify item value to be a long integer. <a href="#gab21e6db9ca7cb8bb4d795702dda30c40"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__modwrap.html#ga3582c6f43cb748d9f9394eb74a1f301d">col_modify_ulong_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item, const char *property, uint64_t number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify item value to be an unsigned long. <a href="#ga3582c6f43cb748d9f9394eb74a1f301d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__modwrap.html#ga29d254b2b6bd027601bc0828f60fdb5f">col_modify_unsigned_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item, const char *property, uint32_t number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify item value to be an unsigned integer. <a href="#ga29d254b2b6bd027601bc0828f60fdb5f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__modwrap.html#ga64e26eee5384c77b7de940d06bc073dc">col_modify_double_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *item, const char *property, double number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify item value to be a floating point. <a href="#ga64e26eee5384c77b7de940d06bc073dc"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>The functions in this section are convenience wrappers around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. They return same error codes. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7d200551ebbe59a93f7d8007641f9a6f"></a><!-- doxytag: member="collection.h::col_modify_binary_item" ref="ga7d200551ebbe59a93f7d8007641f9a6f" args="(struct collection_item *item, const char *property, void *binary_data, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_modify_binary_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>
</tr>
<tr>
<td class="paramkey"></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">void * </td>
<td class="paramname"><em>binary_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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify item value to be a binary blob. </p>
<p>This function is a convenience wrapper around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. It sets a value of the item to a provided binary buffer. If property is not NULL it also renames the property. Original value is always destroyed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>- same error values as <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa4319ad401a8d27bbd3380bc900889f4"></a><!-- doxytag: member="collection.h::col_modify_bool_item" ref="gaa4319ad401a8d27bbd3380bc900889f4" args="(struct collection_item *item, const char *property, unsigned char logical)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_modify_bool_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>
</tr>
<tr>
<td class="paramkey"></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">unsigned char </td>
<td class="paramname"><em>logical</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify item value to be a Boolean. </p>
<p>This function is a convenience wrapper around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. It sets a value of the item to a provided logical value. If property is not NULL it also renames the property. Original value is always destroyed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>- same error values as <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga64e26eee5384c77b7de940d06bc073dc"></a><!-- doxytag: member="collection.h::col_modify_double_item" ref="ga64e26eee5384c77b7de940d06bc073dc" args="(struct collection_item *item, const char *property, double number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_modify_double_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>
</tr>
<tr>
<td class="paramkey"></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">double </td>
<td class="paramname"><em>number</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify item value to be a floating point. </p>
<p>This function is a convenience wrapper around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. It sets a value of the item to a provided floating point value. If property is not NULL it also renames the property. Original value is always destroyed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>- same error values as <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="gabe2cb392565b7fc6d8f4fa8fc051390d"></a><!-- doxytag: member="collection.h::col_modify_int_item" ref="gabe2cb392565b7fc6d8f4fa8fc051390d" args="(struct collection_item *item, const char *property, int32_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_modify_int_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>
</tr>
<tr>
<td class="paramkey"></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">int32_t </td>
<td class="paramname"><em>number</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify item value to be an integer. </p>
<p>This function is a convenience wrapper around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. It sets a value of the item to a provided integer value. If property is not NULL it also renames the property. Original value is always destroyed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>- same error values as <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="gafe79b2532c922391868556c004d8f7fa"></a><!-- doxytag: member="collection.h::col_modify_item_property" ref="gafe79b2532c922391868556c004d8f7fa" args="(struct collection_item *item, const char *property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_modify_item_property </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>property</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify item property. </p>
<p>This function is a convenience wrapper around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. It is equivalent to: col_modify_item(item, property, 0, NULL, 0); </p>
</div>
</div>
<a class="anchor" id="gab21e6db9ca7cb8bb4d795702dda30c40"></a><!-- doxytag: member="collection.h::col_modify_long_item" ref="gab21e6db9ca7cb8bb4d795702dda30c40" args="(struct collection_item *item, const char *property, int64_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_modify_long_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>
</tr>
<tr>
<td class="paramkey"></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">int64_t </td>
<td class="paramname"><em>number</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify item value to be a long integer. </p>
<p>This function is a convenience wrapper around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. It sets a value of the item to a provided long integer value. If property is not NULL it also renames the property. Original value is always destroyed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>- same error values as <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga525e5ce9400ec5870681797f890eb14e"></a><!-- doxytag: member="collection.h::col_modify_str_item" ref="ga525e5ce9400ec5870681797f890eb14e" args="(struct collection_item *item, const char *property, const char *string, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_modify_str_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>
</tr>
<tr>
<td class="paramkey"></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">const char * </td>
<td class="paramname"><em>string</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>Modify item value to be a string. </p>
<p>This function is a convenience wrapper around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. It sets a value of the item to a provided string. If property is not NULL it also renames the property. If the length argument is not zero the string will be truncated to this length. If the length is 0 the length will be calculated based on the length of the actual string. Original value is always destroyed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>- same error values as <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga3582c6f43cb748d9f9394eb74a1f301d"></a><!-- doxytag: member="collection.h::col_modify_ulong_item" ref="ga3582c6f43cb748d9f9394eb74a1f301d" args="(struct collection_item *item, const char *property, uint64_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_modify_ulong_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>
</tr>
<tr>
<td class="paramkey"></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">uint64_t </td>
<td class="paramname"><em>number</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify item value to be an unsigned long. </p>
<p>This function is a convenience wrapper around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. It sets a value of the item to a provided unsigned long value. If property is not NULL it also renames the property. Original value is always destroyed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>- same error values as <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga29d254b2b6bd027601bc0828f60fdb5f"></a><!-- doxytag: member="collection.h::col_modify_unsigned_item" ref="ga29d254b2b6bd027601bc0828f60fdb5f" args="(struct collection_item *item, const char *property, uint32_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_modify_unsigned_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>
</tr>
<tr>
<td class="paramkey"></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">uint32_t </td>
<td class="paramname"><em>number</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify item value to be an unsigned integer. </p>
<p>This function is a convenience wrapper around <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. It sets a value of the item to a provided unsigned integer value. If property is not NULL it also renames the property. Original value is always destroyed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>- same error values as <a class="el" href="group__getitem.html#gaffce843dbd40ba630f85110c2b34b2f7">col_modify_item</a>. </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>
