diff options
author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
---|---|---|
committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
commit | d12e43bc201e15edffcdf94fe820aeae6ab44882 (patch) | |
tree | 90aa12006b20849b65b7bc8e3d4fe60a488f7247 /interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html | |
parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html')
-rw-r--r-- | interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html | 205 |
1 files changed, 205 insertions, 0 deletions
diff --git a/interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html b/interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html new file mode 100644 index 0000000..c0ac14e --- /dev/null +++ b/interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html @@ -0,0 +1,205 @@ +<!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.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>HDF5: H5A_iterate_cb Interface 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.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> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(function() { init_search(); }); +/* @license-end */ +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="hdf5doxy.css" rel="stylesheet" type="text/css"> +<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/> + --> +<script type="text/javascript" src="hdf5_navtree_hacks.js"></script> +</head> +<body> +<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div> +<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="HDFG-logo.png"/></td> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a> +  <span id="projectnumber">1.15.0.ab4d2ae</span> + </div> + <div id="projectbrief">API Reference</div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.svg" + 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.svg" alt=""/></a> + </span> + </div> +</td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- 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 class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">H5A_iterate_cb Interface Reference</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Information class for link callback for H5Aiterate. </p> +</div><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for H5A_iterate_cb:</div> +<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-0-content" class="dyncontent" style="display:none;"> +<div class="center"><img src="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb__inherit__graph.png" border="0" usemap="#a_h5_a__iterate__cb_inherit__map" alt="Inheritance graph"/></div> +<map name="a_h5_a__iterate__cb_inherit__map" id="a_h5_a__iterate__cb_inherit__map"> +<area shape="rect" title=" " alt="" coords="5,80,127,107"/> +<area shape="rect" title=" " alt="" coords="23,5,109,32"/> +</map> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> +<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for H5A_iterate_cb:</div> +<div id="dynsection-1-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-1-content" class="dyncontent" style="display:none;"> +<div class="center"><img src="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb__coll__graph.png" border="0" usemap="#a_h5_a__iterate__cb_coll__map" alt="Collaboration graph"/></div> +<map name="a_h5_a__iterate__cb_coll__map" id="a_h5_a__iterate__cb_coll__map"> +<area shape="rect" title=" " alt="" coords="5,80,127,107"/> +<area shape="rect" title=" " alt="" coords="23,5,109,32"/> +</map> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a223b69d7cecd30c55588b636c0df5dab"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html#a223b69d7cecd30c55588b636c0df5dab">callback</a> (long loc_id, String name, <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_a__info__t.html">H5A_info_t</a> info, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__t.html">H5A_iterate_t</a> op_data)</td></tr> +<tr class="separator:a223b69d7cecd30c55588b636c0df5dab"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a223b69d7cecd30c55588b636c0df5dab"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a223b69d7cecd30c55588b636c0df5dab">◆ </a></span>callback()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int callback </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_a__info__t.html">H5A_info_t</a> </td> + <td class="paramname"><em>info</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__t.html">H5A_iterate_t</a> </td> + <td class="paramname"><em>op_data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>application callback for each attribute</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>the ID for the group or dataset being iterated over </td></tr> + <tr><td class="paramname">name</td><td>the name of the current attribute about the object </td></tr> + <tr><td class="paramname">info</td><td>the attribute's "info" struct </td></tr> + <tr><td class="paramname">op_data</td><td>the operator data passed in to H5Aiterate</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>operation status A. Zero causes the iterator to continue, returning zero when all attributes have been processed. B. Positive causes the iterator to immediately return that positive value, indicating short-circuit success. The iterator can be restarted at the next attribute. C. Negative causes the iterator to immediately return that value, indicating failure. The iterator can be restarted at the next attribute. </dd></dl> + +</div> +</div> +<hr/>The documentation for this interface was generated from the following file:<ul> +<li>java/src/hdf/hdf5lib/callbacks/<a class="el" href="_h5_a__iterate__cb_8java.html">H5A_iterate_cb.java</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><b>hdf</b></li><li class="navelem"><b>hdf5lib</b></li><li class="navelem"><a class="el" href="namespacehdf_1_1hdf5lib_1_1callbacks.html">callbacks</a></li><li class="navelem"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html">H5A_iterate_cb</a></li> + <li class="footer">Generated on Mon Jun 26 2023 19:01:40 for HDF5 by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + </ul> +</div> +</body> +</html> |