<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>libcollection: Disposition constants</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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>
<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><!-- top -->
<!-- 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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</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>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Disposition constants<div class="ingroups"><a class="el" href="group__collection.html">COLLECTION interface</a> » <a class="el" href="group__getitem.html">Item management</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaa74f679fb77b06d2f32e8dc8f7862af2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dispvalues.html#gaa74f679fb77b06d2f32e8dc8f7862af2">COL_DSP_END</a>   0</td></tr>
<tr class="memdesc:gaa74f679fb77b06d2f32e8dc8f7862af2"><td class="mdescLeft"> </td><td class="mdescRight">Relate to the end of the collection. <a href="#gaa74f679fb77b06d2f32e8dc8f7862af2">More...</a><br /></td></tr>
<tr class="separator:gaa74f679fb77b06d2f32e8dc8f7862af2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gada9591bf91ac75672af4c428079089b4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dispvalues.html#gada9591bf91ac75672af4c428079089b4">COL_DSP_FRONT</a>   1</td></tr>
<tr class="memdesc:gada9591bf91ac75672af4c428079089b4"><td class="mdescLeft"> </td><td class="mdescRight">Relate to the beginning of the collection. <a href="#gada9591bf91ac75672af4c428079089b4">More...</a><br /></td></tr>
<tr class="separator:gada9591bf91ac75672af4c428079089b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9877b126fa367a02ed92bed712507b57"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dispvalues.html#ga9877b126fa367a02ed92bed712507b57">COL_DSP_BEFORE</a>   2</td></tr>
<tr class="memdesc:ga9877b126fa367a02ed92bed712507b57"><td class="mdescLeft"> </td><td class="mdescRight">Before the given property. <a href="#ga9877b126fa367a02ed92bed712507b57">More...</a><br /></td></tr>
<tr class="separator:ga9877b126fa367a02ed92bed712507b57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa41be79405bbca6915408cb56b61ad5c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dispvalues.html#gaa41be79405bbca6915408cb56b61ad5c">COL_DSP_AFTER</a>   3</td></tr>
<tr class="memdesc:gaa41be79405bbca6915408cb56b61ad5c"><td class="mdescLeft"> </td><td class="mdescRight">After the given property. <a href="#gaa41be79405bbca6915408cb56b61ad5c">More...</a><br /></td></tr>
<tr class="separator:gaa41be79405bbca6915408cb56b61ad5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga736f034e8506af226a8d2c45be7ca804"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dispvalues.html#ga736f034e8506af226a8d2c45be7ca804">COL_DSP_INDEX</a>   4</td></tr>
<tr class="memdesc:ga736f034e8506af226a8d2c45be7ca804"><td class="mdescLeft"> </td><td class="mdescRight">Use index. <a href="#ga736f034e8506af226a8d2c45be7ca804">More...</a><br /></td></tr>
<tr class="separator:ga736f034e8506af226a8d2c45be7ca804"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf621284b2af387e02eca88c5be4680c1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dispvalues.html#gaf621284b2af387e02eca88c5be4680c1">COL_DSP_FIRSTDUP</a>   5</td></tr>
<tr class="memdesc:gaf621284b2af387e02eca88c5be4680c1"><td class="mdescLeft"> </td><td class="mdescRight">Use first among duplicates. <a href="#gaf621284b2af387e02eca88c5be4680c1">More...</a><br /></td></tr>
<tr class="separator:gaf621284b2af387e02eca88c5be4680c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab55972884ff55f11e97f431d39c341b4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dispvalues.html#gab55972884ff55f11e97f431d39c341b4">COL_DSP_LASTDUP</a>   6</td></tr>
<tr class="memdesc:gab55972884ff55f11e97f431d39c341b4"><td class="mdescLeft"> </td><td class="mdescRight">Use last among duplicates. <a href="#gab55972884ff55f11e97f431d39c341b4">More...</a><br /></td></tr>
<tr class="separator:gab55972884ff55f11e97f431d39c341b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga86a76faefd4cf7055c8fe5b0d38ffae2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dispvalues.html#ga86a76faefd4cf7055c8fe5b0d38ffae2">COL_DSP_NDUP</a>   7</td></tr>
<tr class="memdesc:ga86a76faefd4cf7055c8fe5b0d38ffae2"><td class="mdescLeft"> </td><td class="mdescRight">Use N-th among duplicates. <a href="#ga86a76faefd4cf7055c8fe5b0d38ffae2">More...</a><br /></td></tr>
<tr class="separator:ga86a76faefd4cf7055c8fe5b0d38ffae2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Possible dispositions for insert, extract and delete function(s). Not all of these dispositions are implemented day one. If disposition is not implemented the function will return error ENOSYS.</p>
<p>Other dispositions might be possible in future. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaa74f679fb77b06d2f32e8dc8f7862af2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_DSP_END   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Relate to the end of the collection. </p>
<p>For "insert":</p><ul>
<li>Add property to the end of the collection.</li>
</ul>
<p>For "extract" or "delete":</p><ul>
<li>Extract or delete the last property in the collection. </li>
</ul>
</div>
</div>
<a class="anchor" id="gada9591bf91ac75672af4c428079089b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_DSP_FRONT   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Relate to the beginning of the collection. </p>
<p>For "insert":</p><ul>
<li>Add property to the beginning of the collection right after the header.</li>
</ul>
<p>For "extract" or "delete":</p><ul>
<li>Extract or delete the first property in the collection. This is the one right after the header. </li>
</ul>
</div>
</div>
<a class="anchor" id="ga9877b126fa367a02ed92bed712507b57"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_DSP_BEFORE   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Before the given property. </p>
<p>For "insert":</p><ul>
<li>Add property before the referenced property.</li>
</ul>
<p>For "extract" or "delete":</p><ul>
<li>Extract or delete the property that stands before the referenced property in the collection. If given property is the first in the collection ENOENT is returned. </li>
</ul>
</div>
</div>
<a class="anchor" id="gaa41be79405bbca6915408cb56b61ad5c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_DSP_AFTER   3</td>
</tr>
</table>
</div><div class="memdoc">
<p>After the given property. </p>
<p>For "insert":</p><ul>
<li>Add property immediately the referenced property.</li>
</ul>
<p>For "extract" or "delete":</p><ul>
<li>Extract or delete the property that stands after the referenced property in the collection. If given property is the last in the collection ENOENT is returned. </li>
</ul>
</div>
</div>
<a class="anchor" id="ga736f034e8506af226a8d2c45be7ca804"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_DSP_INDEX   4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use index. </p>
<p>For "insert":</p><ul>
<li>The COL_DSP_INDEX adds the item as N-th item after header in the list. Index is zero based. If there are less than N items in the list the item is added to the end. The index value of 0 means that the item will be added immediately after the header. Index of 1 will mean that it is added after first data item and so on.</li>
</ul>
<p>For "extract" or "delete":</p><ul>
<li>In case of extraction or deletion the N-th item of the collection will be extracted or deleted. Index is zero based. If there are less than N+1 items in the list the function will return ENOENT. </li>
</ul>
</div>
</div>
<a class="anchor" id="gaf621284b2af387e02eca88c5be4680c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_DSP_FIRSTDUP   5</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use first among duplicates. </p>
<p>This mode applies only to the list of duplicate properties that are going one after another.</p>
<p>For "insert":</p><ul>
<li>Add property as a first dup of the given property. The property name is taken from the item and the value refprop is ignored.</li>
</ul>
<p>For "extract" or "delete":</p><ul>
<li>Delete or extract first duplicate property. The property name is taken from the refprop. The property will be extracted or deleted if found regardless of whether there are any duplicates or not. </li>
</ul>
</div>
</div>
<a class="anchor" id="gab55972884ff55f11e97f431d39c341b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_DSP_LASTDUP   6</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use last among duplicates. </p>
<p>This mode applies only to the list of duplicate properties that are going one after another.</p>
<p>For "insert":</p><ul>
<li>Add property as the last dup of the given property. The property name is taken from the item and the value refprop is ignored.</li>
</ul>
<p>For "extract" or "delete":</p><ul>
<li>Delete or extract the last duplicate of the property. The property name is taken from the refprop. Extracts or deletes last duplicate property in the uninterrupted sequence of properties with the same name. The property will be extracted or deleted if found regardless of whether there are any duplicates or not. </li>
</ul>
</div>
</div>
<a class="anchor" id="ga86a76faefd4cf7055c8fe5b0d38ffae2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_DSP_NDUP   7</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use N-th among duplicates. </p>
<p>This mode applies only to the list of duplicate properties that are going one after another.</p>
<p>For "insert":</p><ul>
<li>Add property as a N-th dup of the given property. The property name is taken from the item and the value refprop is ignored. Index is zero based. The COL_DSP_NDUP is used in case of the multi value property to add a new property with the same name into specific place in the list of properties with the same name. The index of 0 will mean to add the property before the first instance of the property with the same name. If the property does not exist ENOENT will be returned. If the index is greater than the last property with the same name the item will be added immediately after last property with the same name.</li>
</ul>
<p>For "extract" or "delete":</p><ul>
<li>Delete or extract N-th duplicate property. Index is zero based. The property name is taken from the refprop. If index is greater than number of duplicate properties in the sequence ENOENT is returned. </li>
</ul>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
36966fecacfa2685274a9735a0090042
>
files
>
42
