Mercurial > hg > ucx / file revision

docs/api-2.1/structUcxMapIterator.html@e2243453127f

docs/api-2.1/structUcxMapIterator.html

Wed, 14 Feb 2024 21:31:38 +0100

author
Mike Becker <universe@uap-core.de>
date
Wed, 14 Feb 2024 21:31:38 +0100
changeset 822
e2243453127f
parent 390
d345541018fa
permissions
-rw-r--r--

add code documentation for tree functions

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ucx: UcxMapIterator Struct Reference</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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ucx
   </div>
   <div id="projectbrief">UAP Common Extensions</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">UcxMapIterator Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Structure for an iterator over a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>.  
 <a href="structUcxMapIterator.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="map_8h_source.html">map.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:af88d6e22547d09fe1d665dd650dcdb95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> const  *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMapIterator.html#af88d6e22547d09fe1d665dd650dcdb95">map</a></td></tr>
<tr class="memdesc:af88d6e22547d09fe1d665dd650dcdb95"><td class="mdescLeft">&#160;</td><td class="mdescRight">The map to iterate over.  <a href="#af88d6e22547d09fe1d665dd650dcdb95">More...</a><br /></td></tr>
<tr class="separator:af88d6e22547d09fe1d665dd650dcdb95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1fc40f899f37280adb5b85acf6e742f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMapElement.html">UcxMapElement</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMapIterator.html#af1fc40f899f37280adb5b85acf6e742f">cur</a></td></tr>
<tr class="memdesc:af1fc40f899f37280adb5b85acf6e742f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current map element.  <a href="#af1fc40f899f37280adb5b85acf6e742f">More...</a><br /></td></tr>
<tr class="separator:af1fc40f899f37280adb5b85acf6e742f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2376545c8816dd6895de4995e558c65"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMapIterator.html#ac2376545c8816dd6895de4995e558c65">index</a></td></tr>
<tr class="memdesc:ac2376545c8816dd6895de4995e558c65"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current index of the element list array.  <a href="#ac2376545c8816dd6895de4995e558c65">More...</a><br /></td></tr>
<tr class="separator:ac2376545c8816dd6895de4995e558c65"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Structure for an iterator over a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="af1fc40f899f37280adb5b85acf6e742f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1fc40f899f37280adb5b85acf6e742f">&#9670;&nbsp;</a></span>cur</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structUcxMapElement.html">UcxMapElement</a>* UcxMapIterator::cur</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The current map element. </p>

</div>
</div>
<a id="ac2376545c8816dd6895de4995e558c65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2376545c8816dd6895de4995e558c65">&#9670;&nbsp;</a></span>index</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t UcxMapIterator::index</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The current index of the element list array. </p>
<p><b>Attention: </b> this is <b>NOT</b> the element index! Do <b>NOT</b> manually iterate over the map by increasing this index. Use <a class="el" href="map_8h.html#aceb8675abf44860b4bbc301bbada5b91" title="Proceeds to the next element of the map (if any). ">ucx_map_iter_next()</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxMap.html#a5792b5037c4f77ea3cb144b66c9b8790" title="The array of map element lists. ">UcxMap.map</a> </dd></dl>

</div>
</div>
<a id="af88d6e22547d09fe1d665dd650dcdb95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af88d6e22547d09fe1d665dd650dcdb95">&#9670;&nbsp;</a></span>map</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a> const* UcxMapIterator::map</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The map to iterate over. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/mike/workspace/c/ucx/src/ucx/<a class="el" href="map_8h_source.html">map.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 19 2019 19:58:24 for ucx by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

Mercurial Repository: ucx

mercurial