<!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: Insert property functions</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">Insert property functions</div> </div> <div class="ingroups"><a class="el" href="group__collection.html">COLLECTION interface</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"><a class="anchor" id="gae472aa41b9b152f164055bebc389f9a0"></a><!-- doxytag: member="insertproperty::col_insert_str_property" ref="gae472aa41b9b152f164055bebc389f9a0" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, const char *string, int length)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#gae472aa41b9b152f164055bebc389f9a0">col_insert_str_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, const char *string, int length)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a string property. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa9e4fd27cdb618ab5331fb6b9c18b80a"></a><!-- doxytag: member="insertproperty::col_insert_binary_property" ref="gaa9e4fd27cdb618ab5331fb6b9c18b80a" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, void *binary_data, int length)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#gaa9e4fd27cdb618ab5331fb6b9c18b80a">col_insert_binary_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, void *binary_data, int length)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a binary property. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4aae8775227234d0dc71d8cfa23c1d4c"></a><!-- doxytag: member="insertproperty::col_insert_int_property" ref="ga4aae8775227234d0dc71d8cfa23c1d4c" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int32_t number)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga4aae8775227234d0dc71d8cfa23c1d4c">col_insert_int_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int32_t number)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert an integer property. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0085eba25d05ac745e0defcc91aad34e"></a><!-- doxytag: member="insertproperty::col_insert_unsinged_property" ref="ga0085eba25d05ac745e0defcc91aad34e" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, uint32_t number)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga0085eba25d05ac745e0defcc91aad34e">col_insert_unsinged_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, uint32_t number)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert an unsigned property. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga15164ef2aa7d17799243824d5386f8b8"></a><!-- doxytag: member="insertproperty::col_insert_long_property" ref="ga15164ef2aa7d17799243824d5386f8b8" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int64_t number)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga15164ef2aa7d17799243824d5386f8b8">col_insert_long_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int64_t number)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a long property. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa84f242ccf493d07bfe7a1cb0c7db742"></a><!-- doxytag: member="insertproperty::col_insert_ulong_property" ref="gaa84f242ccf493d07bfe7a1cb0c7db742" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, uint64_t number)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#gaa84f242ccf493d07bfe7a1cb0c7db742">col_insert_ulong_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, uint64_t number)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert an unsigned long property. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab1e4327911a5026dad2c52b83d2c31f0"></a><!-- doxytag: member="insertproperty::col_insert_double_property" ref="gab1e4327911a5026dad2c52b83d2c31f0" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, double number)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#gab1e4327911a5026dad2c52b83d2c31f0">col_insert_double_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, double number)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a property with a floating point value. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga62f04f9f6d41cb918da4fda3ce95a8d9"></a><!-- doxytag: member="insertproperty::col_insert_bool_property" ref="ga62f04f9f6d41cb918da4fda3ce95a8d9" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, unsigned char logical)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga62f04f9f6d41cb918da4fda3ce95a8d9">col_insert_bool_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, unsigned char logical)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a property with a Boolean value. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga106917ab963594f18f21da4f4a42b6f7"></a><!-- doxytag: member="insertproperty::col_insert_str_property_with_ref" ref="ga106917ab963594f18f21da4f4a42b6f7" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, const char *string, int length, struct collection_item **ret_ref)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga106917ab963594f18f21da4f4a42b6f7">col_insert_str_property_with_ref</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, const char *string, int length, struct <a class="el" href="structcollection__item.html">collection_item</a> **ret_ref)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a string property and get back a reference. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga64877a67d7b68a1a1f3122489ba8c444"></a><!-- doxytag: member="insertproperty::col_insert_binary_property_with_ref" ref="ga64877a67d7b68a1a1f3122489ba8c444" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, void *binary_data, int length, struct collection_item **ret_ref)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga64877a67d7b68a1a1f3122489ba8c444">col_insert_binary_property_with_ref</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, void *binary_data, int length, struct <a class="el" href="structcollection__item.html">collection_item</a> **ret_ref)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a binary property and get back a reference. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3aa40cb9b145c921a102ae9a52750038"></a><!-- doxytag: member="insertproperty::col_insert_int_property_with_ref" ref="ga3aa40cb9b145c921a102ae9a52750038" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int32_t number, struct collection_item **ret_ref)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga3aa40cb9b145c921a102ae9a52750038">col_insert_int_property_with_ref</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int32_t number, struct <a class="el" href="structcollection__item.html">collection_item</a> **ret_ref)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert an integer property and get back a reference. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga796fd0fc92b3f3d039b0fe5885049bbf"></a><!-- doxytag: member="insertproperty::col_insert_unsinged_property_with_ref" ref="ga796fd0fc92b3f3d039b0fe5885049bbf" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, uint32_t number, struct collection_item **ret_ref)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga796fd0fc92b3f3d039b0fe5885049bbf">col_insert_unsinged_property_with_ref</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, uint32_t number, struct <a class="el" href="structcollection__item.html">collection_item</a> **ret_ref)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert an unsigned property and get back a reference. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5ebaf0316e0c2ec2e55e0b8ac5a9f684"></a><!-- doxytag: member="insertproperty::col_insert_long_property_with_ref" ref="ga5ebaf0316e0c2ec2e55e0b8ac5a9f684" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int64_t number, struct collection_item **ret_ref)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga5ebaf0316e0c2ec2e55e0b8ac5a9f684">col_insert_long_property_with_ref</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int64_t number, struct <a class="el" href="structcollection__item.html">collection_item</a> **ret_ref)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a long property and get back a reference. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga520c17fdaf724517d78cb3abd2a8320c"></a><!-- doxytag: member="insertproperty::col_insert_ulong_property_with_ref" ref="ga520c17fdaf724517d78cb3abd2a8320c" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, uint64_t number, struct collection_item **ret_ref)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga520c17fdaf724517d78cb3abd2a8320c">col_insert_ulong_property_with_ref</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, uint64_t number, struct <a class="el" href="structcollection__item.html">collection_item</a> **ret_ref)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert an unsigned long property and get back a reference. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga42ea36f0ff4715b7900b71d65520912f"></a><!-- doxytag: member="insertproperty::col_insert_double_property_with_ref" ref="ga42ea36f0ff4715b7900b71d65520912f" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, double number, struct collection_item **ret_ref)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga42ea36f0ff4715b7900b71d65520912f">col_insert_double_property_with_ref</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, double number, struct <a class="el" href="structcollection__item.html">collection_item</a> **ret_ref)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a property with a floating point value and get back a reference. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3bdd657802f54f336c8eea4f989dd01a"></a><!-- doxytag: member="insertproperty::col_insert_bool_property_with_ref" ref="ga3bdd657802f54f336c8eea4f989dd01a" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, unsigned char logical, struct collection_item **ret_ref)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga3bdd657802f54f336c8eea4f989dd01a">col_insert_bool_property_with_ref</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, unsigned char logical, struct <a class="el" href="structcollection__item.html">collection_item</a> **ret_ref)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a property with a Boolean value and get back a reference. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8f901729a19bf30f83d85731f182a194"></a><!-- doxytag: member="insertproperty::col_insert_property_with_ref" ref="ga8f901729a19bf30f83d85731f182a194" args="(struct collection_item *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int type, const void *data, int length, struct collection_item **ret_ref)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__insertproperty.html#ga8f901729a19bf30f83d85731f182a194">col_insert_property_with_ref</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *ci, const char *subcollection, int disposition, const char *refprop, int idx, unsigned flags, const char *property, int type, const void *data, int length, struct <a class="el" href="structcollection__item.html">collection_item</a> **ret_ref)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Insert property of any type and get back a reference. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <p>Functions in this section insert properties into a collection at a specified position.</p> <p>Common parameters for these functions are:</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">ci</td><td>Root collection object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">subcollection</td><td>Name of the inner collection to add property to. If NULL the property is added to the root collection. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>Defines relation point. For more information see <a class="el" href="group__dispvalues.html">disposition defines</a>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">refprop</td><td>Property to relate to </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>Index (see comments below). </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Flags that control naming issues. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">property</td><td>Name of the property.<br/> Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/> Maximum allowed length is defined at compile time. The default value is 64k.</td></tr> </table> </dd> </dl> <p>Other arguments are the same as the arguments for the <a class="el" href="group__addproperty.html">col_add_xxx_property</a> functions.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was insterted successfully. </dd> <dd> ENOMEM - No memory. </dd> <dd> EINVAL - Invalid characters in the property name. Value argument is invalid in some way. </dd> <dd> EMSGSIZE - Property name is too long. </dd> <dd> ENOENT - Sub collection or property to relate to is not found. </dd> <dd> EEXIST - Property with given name already exists. This error is returned if collection should hold unique names. For more information see description of the "flags" argument. </dd> <dd> ENOSYS - Flag or disposition value is not implemented. </dd></dl> </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>