Files
hdf5/develop/struct_h5_l__class__t.html
T
2024-02-09 17:39:10 +00:00

300 lines
15 KiB
HTML

<!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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: H5L_class_t 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="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>
<script type="text/javascript" src="cookie.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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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>
&#160;<span id="projectnumber">1.15.0.33bb197</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="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.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('struct_h5_l__class__t.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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">H5L_class_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;src/H5Ldevelop.h&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Link prototype. </p>
<p>The <a class="el" href="struct_h5_l__class__t.html" title="Link prototype.">H5L_class_t</a> struct can be used to override the behavior of a "user-defined" link class. Users should populate the struct with callback functions defined elsewhere. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aad880fc4455c253781e8968f2239d56f" id="r_aad880fc4455c253781e8968f2239d56f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aad880fc4455c253781e8968f2239d56f">version</a></td></tr>
<tr class="separator:aad880fc4455c253781e8968f2239d56f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41290dd828f401091a1f99244fefec94" id="r_a41290dd828f401091a1f99244fefec94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a41290dd828f401091a1f99244fefec94">id</a></td></tr>
<tr class="separator:a41290dd828f401091a1f99244fefec94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8c2c4e6dab650ca0dbc32956838ddd9" id="r_ae8c2c4e6dab650ca0dbc32956838ddd9"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8c2c4e6dab650ca0dbc32956838ddd9">comment</a></td></tr>
<tr class="separator:ae8c2c4e6dab650ca0dbc32956838ddd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53540f55f0fad8df1356d454b491c75f" id="r_a53540f55f0fad8df1356d454b491c75f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ldevelop_8h.html#a35f5eeac9ed28bfcc94d5037cac5af4a">H5L_create_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a53540f55f0fad8df1356d454b491c75f">create_func</a></td></tr>
<tr class="separator:a53540f55f0fad8df1356d454b491c75f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56689cfa9cb353a2a54057b182abe15a" id="r_a56689cfa9cb353a2a54057b182abe15a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ldevelop_8h.html#a923e0abe07eacf3101ba6e717665edf1">H5L_move_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a56689cfa9cb353a2a54057b182abe15a">move_func</a></td></tr>
<tr class="separator:a56689cfa9cb353a2a54057b182abe15a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa88eb168134450bc4ee2666fc03dd4d" id="r_aaa88eb168134450bc4ee2666fc03dd4d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ldevelop_8h.html#a5800df80f7709b30fa99dfc5166468e5">H5L_copy_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaa88eb168134450bc4ee2666fc03dd4d">copy_func</a></td></tr>
<tr class="separator:aaa88eb168134450bc4ee2666fc03dd4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91ea6444409d489eecd46c195679d269" id="r_a91ea6444409d489eecd46c195679d269"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ldevelop_8h.html#a7daba3925a1b3b28a1944788d2a88597">H5L_traverse_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a91ea6444409d489eecd46c195679d269">trav_func</a></td></tr>
<tr class="separator:a91ea6444409d489eecd46c195679d269"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4c297a9452c4e152d9308877ae80e5e" id="r_ab4c297a9452c4e152d9308877ae80e5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ldevelop_8h.html#a4ef5c91e382760e74fb95a480f0773ca">H5L_delete_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4c297a9452c4e152d9308877ae80e5e">del_func</a></td></tr>
<tr class="separator:ab4c297a9452c4e152d9308877ae80e5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2de75a8113b69359b8919f694acdeec" id="r_ab2de75a8113b69359b8919f694acdeec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ldevelop_8h.html#a4ed3f3e89fe170d547cefd7d68549632">H5L_query_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2de75a8113b69359b8919f694acdeec">query_func</a></td></tr>
<tr class="separator:ab2de75a8113b69359b8919f694acdeec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="ae8c2c4e6dab650ca0dbc32956838ddd9" name="ae8c2c4e6dab650ca0dbc32956838ddd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8c2c4e6dab650ca0dbc32956838ddd9">&#9670;&#160;</a></span>comment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* comment</td>
</tr>
</table>
</div><div class="memdoc">
<p>Comment for debugging <br />
</p>
</div>
</div>
<a id="aaa88eb168134450bc4ee2666fc03dd4d" name="aaa88eb168134450bc4ee2666fc03dd4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa88eb168134450bc4ee2666fc03dd4d">&#9670;&#160;</a></span>copy_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ldevelop_8h.html#a5800df80f7709b30fa99dfc5166468e5">H5L_copy_func_t</a> copy_func</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback after copying link <br />
</p>
</div>
</div>
<a id="a53540f55f0fad8df1356d454b491c75f" name="a53540f55f0fad8df1356d454b491c75f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53540f55f0fad8df1356d454b491c75f">&#9670;&#160;</a></span>create_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ldevelop_8h.html#a35f5eeac9ed28bfcc94d5037cac5af4a">H5L_create_func_t</a> create_func</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback during link creation <br />
</p>
</div>
</div>
<a id="ab4c297a9452c4e152d9308877ae80e5e" name="ab4c297a9452c4e152d9308877ae80e5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4c297a9452c4e152d9308877ae80e5e">&#9670;&#160;</a></span>del_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ldevelop_8h.html#a4ef5c91e382760e74fb95a480f0773ca">H5L_delete_func_t</a> del_func</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback for link deletion <br />
</p>
</div>
</div>
<a id="a41290dd828f401091a1f99244fefec94" name="a41290dd828f401091a1f99244fefec94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41290dd828f401091a1f99244fefec94">&#9670;&#160;</a></span>id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a> id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Link type ID <br />
</p>
</div>
</div>
<a id="a56689cfa9cb353a2a54057b182abe15a" name="a56689cfa9cb353a2a54057b182abe15a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56689cfa9cb353a2a54057b182abe15a">&#9670;&#160;</a></span>move_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ldevelop_8h.html#a923e0abe07eacf3101ba6e717665edf1">H5L_move_func_t</a> move_func</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback after moving link <br />
</p>
</div>
</div>
<a id="ab2de75a8113b69359b8919f694acdeec" name="ab2de75a8113b69359b8919f694acdeec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2de75a8113b69359b8919f694acdeec">&#9670;&#160;</a></span>query_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ldevelop_8h.html#a4ed3f3e89fe170d547cefd7d68549632">H5L_query_func_t</a> query_func</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback for queries <br />
</p>
</div>
</div>
<a id="a91ea6444409d489eecd46c195679d269" name="a91ea6444409d489eecd46c195679d269"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91ea6444409d489eecd46c195679d269">&#9670;&#160;</a></span>trav_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ldevelop_8h.html#a7daba3925a1b3b28a1944788d2a88597">H5L_traverse_func_t</a> trav_func</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback during link traversal <br />
</p>
</div>
</div>
<a id="aad880fc4455c253781e8968f2239d56f" name="aad880fc4455c253781e8968f2239d56f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad880fc4455c253781e8968f2239d56f">&#9670;&#160;</a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Version number of this struct <br />
</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="_h5_ldevelop_8h.html">H5Ldevelop.h</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"><a class="el" href="struct_h5_l__class__t.html">H5L_class_t</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>