docs/api-2.1/structUcxMapIterator.html

changeset 390
d345541018fa
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/api-2.1/structUcxMapIterator.html	Sat Feb 06 19:11:44 2021 +0100
     1.3 @@ -0,0 +1,150 @@
     1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     1.5 +<html xmlns="http://www.w3.org/1999/xhtml">
     1.6 +<head>
     1.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
     1.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
     1.9 +<meta name="generator" content="Doxygen 1.8.13"/>
    1.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
    1.11 +<title>ucx: UcxMapIterator Struct Reference</title>
    1.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
    1.13 +<script type="text/javascript" src="jquery.js"></script>
    1.14 +<script type="text/javascript" src="dynsections.js"></script>
    1.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
    1.16 +<script type="text/javascript" src="search/searchdata.js"></script>
    1.17 +<script type="text/javascript" src="search/search.js"></script>
    1.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
    1.19 +</head>
    1.20 +<body>
    1.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    1.22 +<div id="titlearea">
    1.23 +<table cellspacing="0" cellpadding="0">
    1.24 + <tbody>
    1.25 + <tr style="height: 56px;">
    1.26 +  <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
    1.27 +  <td id="projectalign" style="padding-left: 0.5em;">
    1.28 +   <div id="projectname">ucx
    1.29 +   </div>
    1.30 +   <div id="projectbrief">UAP Common Extensions</div>
    1.31 +  </td>
    1.32 + </tr>
    1.33 + </tbody>
    1.34 +</table>
    1.35 +</div>
    1.36 +<!-- end header part -->
    1.37 +<!-- Generated by Doxygen 1.8.13 -->
    1.38 +<script type="text/javascript">
    1.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
    1.40 +</script>
    1.41 +<script type="text/javascript" src="menudata.js"></script>
    1.42 +<script type="text/javascript" src="menu.js"></script>
    1.43 +<script type="text/javascript">
    1.44 +$(function() {
    1.45 +  initMenu('',true,false,'search.php','Search');
    1.46 +  $(document).ready(function() { init_search(); });
    1.47 +});
    1.48 +</script>
    1.49 +<div id="main-nav"></div>
    1.50 +<!-- window showing the filter options -->
    1.51 +<div id="MSearchSelectWindow"
    1.52 +     onmouseover="return searchBox.OnSearchSelectShow()"
    1.53 +     onmouseout="return searchBox.OnSearchSelectHide()"
    1.54 +     onkeydown="return searchBox.OnSearchSelectKey(event)">
    1.55 +</div>
    1.56 +
    1.57 +<!-- iframe showing the search results (closed by default) -->
    1.58 +<div id="MSearchResultsWindow">
    1.59 +<iframe src="javascript:void(0)" frameborder="0" 
    1.60 +        name="MSearchResults" id="MSearchResults">
    1.61 +</iframe>
    1.62 +</div>
    1.63 +
    1.64 +</div><!-- top -->
    1.65 +<div class="header">
    1.66 +  <div class="summary">
    1.67 +<a href="#pub-attribs">Data Fields</a>  </div>
    1.68 +  <div class="headertitle">
    1.69 +<div class="title">UcxMapIterator Struct Reference</div>  </div>
    1.70 +</div><!--header-->
    1.71 +<div class="contents">
    1.72 +
    1.73 +<p>Structure for an iterator over a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>.  
    1.74 + <a href="structUcxMapIterator.html#details">More...</a></p>
    1.75 +
    1.76 +<p><code>#include &lt;<a class="el" href="map_8h_source.html">map.h</a>&gt;</code></p>
    1.77 +<table class="memberdecls">
    1.78 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
    1.79 +Data Fields</h2></td></tr>
    1.80 +<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>
    1.81 +<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>
    1.82 +<tr class="separator:af88d6e22547d09fe1d665dd650dcdb95"><td class="memSeparator" colspan="2">&#160;</td></tr>
    1.83 +<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>
    1.84 +<tr class="memdesc:af1fc40f899f37280adb5b85acf6e742f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current map element.  <a href="#af1fc40f899f37280adb5b85acf6e742f">More...</a><br /></td></tr>
    1.85 +<tr class="separator:af1fc40f899f37280adb5b85acf6e742f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    1.86 +<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>
    1.87 +<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>
    1.88 +<tr class="separator:ac2376545c8816dd6895de4995e558c65"><td class="memSeparator" colspan="2">&#160;</td></tr>
    1.89 +</table>
    1.90 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    1.91 +<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>
    1.92 +</div><h2 class="groupheader">Field Documentation</h2>
    1.93 +<a id="af1fc40f899f37280adb5b85acf6e742f"></a>
    1.94 +<h2 class="memtitle"><span class="permalink"><a href="#af1fc40f899f37280adb5b85acf6e742f">&#9670;&nbsp;</a></span>cur</h2>
    1.95 +
    1.96 +<div class="memitem">
    1.97 +<div class="memproto">
    1.98 +      <table class="memname">
    1.99 +        <tr>
   1.100 +          <td class="memname"><a class="el" href="structUcxMapElement.html">UcxMapElement</a>* UcxMapIterator::cur</td>
   1.101 +        </tr>
   1.102 +      </table>
   1.103 +</div><div class="memdoc">
   1.104 +
   1.105 +<p>The current map element. </p>
   1.106 +
   1.107 +</div>
   1.108 +</div>
   1.109 +<a id="ac2376545c8816dd6895de4995e558c65"></a>
   1.110 +<h2 class="memtitle"><span class="permalink"><a href="#ac2376545c8816dd6895de4995e558c65">&#9670;&nbsp;</a></span>index</h2>
   1.111 +
   1.112 +<div class="memitem">
   1.113 +<div class="memproto">
   1.114 +      <table class="memname">
   1.115 +        <tr>
   1.116 +          <td class="memname">size_t UcxMapIterator::index</td>
   1.117 +        </tr>
   1.118 +      </table>
   1.119 +</div><div class="memdoc">
   1.120 +
   1.121 +<p>The current index of the element list array. </p>
   1.122 +<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>
   1.123 +
   1.124 +</div>
   1.125 +</div>
   1.126 +<a id="af88d6e22547d09fe1d665dd650dcdb95"></a>
   1.127 +<h2 class="memtitle"><span class="permalink"><a href="#af88d6e22547d09fe1d665dd650dcdb95">&#9670;&nbsp;</a></span>map</h2>
   1.128 +
   1.129 +<div class="memitem">
   1.130 +<div class="memproto">
   1.131 +      <table class="memname">
   1.132 +        <tr>
   1.133 +          <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a> const* UcxMapIterator::map</td>
   1.134 +        </tr>
   1.135 +      </table>
   1.136 +</div><div class="memdoc">
   1.137 +
   1.138 +<p>The map to iterate over. </p>
   1.139 +
   1.140 +</div>
   1.141 +</div>
   1.142 +<hr/>The documentation for this struct was generated from the following file:<ul>
   1.143 +<li>/home/mike/workspace/c/ucx/src/ucx/<a class="el" href="map_8h_source.html">map.h</a></li>
   1.144 +</ul>
   1.145 +</div><!-- contents -->
   1.146 +<!-- start footer part -->
   1.147 +<hr class="footer"/><address class="footer"><small>
   1.148 +Generated on Thu Dec 19 2019 19:58:24 for ucx by &#160;<a href="http://www.doxygen.org/index.html">
   1.149 +<img class="footer" src="doxygen.png" alt="doxygen"/>
   1.150 +</a> 1.8.13
   1.151 +</small></address>
   1.152 +</body>
   1.153 +</html>

mercurial