diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2024-01-29 19:10:27 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2024-01-29 19:10:27 (GMT) |
| commit | 63b7d411312cb7c38efd1648363e347f27c24048 (patch) | |
| tree | af34e5dc2c0cdb79bc809e2034f7d8c7fed6e2e4 /develop/group___c_o_m_p_e_n_u_m.html | |
| parent | 6ba66d0a9efca6f012934bfbeb9bf4ef19465bbd (diff) | |
| download | hdf5-63b7d411312cb7c38efd1648363e347f27c24048.zip hdf5-63b7d411312cb7c38efd1648363e347f27c24048.tar.gz hdf5-63b7d411312cb7c38efd1648363e347f27c24048.tar.bz2 | |
deploy: 365e23340cd001ee751da366235ae420156ad728
Diffstat (limited to 'develop/group___c_o_m_p_e_n_u_m.html')
| -rw-r--r-- | develop/group___c_o_m_p_e_n_u_m.html | 132 |
1 files changed, 54 insertions, 78 deletions
diff --git a/develop/group___c_o_m_p_e_n_u_m.html b/develop/group___c_o_m_p_e_n_u_m.html index 709be26..a1c7f33 100644 --- a/develop/group___c_o_m_p_e_n_u_m.html +++ b/develop/group___c_o_m_p_e_n_u_m.html @@ -3,7 +3,7 @@ <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="generator" content="Doxygen 1.10.0"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>HDF5: Compound and Enumeration Datatypes</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -13,12 +13,13 @@ <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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ - $(document).ready(function() { init_search(); }); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ + $(function() { init_search(); }); /* @license-end */ </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> @@ -37,17 +38,14 @@ <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.5f5f5f0</span> +  <span id="projectnumber">1.15.0.365e233</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" + <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span> + <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> @@ -61,10 +59,10 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.1 --> +<!-- Generated by Doxygen 1.10.0 --> <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 magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search/",'.html'); /* @license-end */ </script> </div><!-- top --> @@ -79,8 +77,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); </div> </div> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ -$(document).ready(function(){initNavTree('group___c_o_m_p_e_n_u_m.html',''); initResizable(); }); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +$(function(){initNavTree('group___c_o_m_p_e_n_u_m.html',''); initResizable(); }); /* @license-end */ </script> <div id="doc-content"> @@ -93,56 +91,49 @@ $(document).ready(function(){initNavTree('group___c_o_m_p_e_n_u_m.html',''); ini <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> +<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="#groups">Modules</a> | +<a href="#groups">Topics</a> | <a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Compound and Enumeration Datatypes<div class="ingroups"><a class="el" href="group___h5_t.html">Datatypes (H5T)</a></div></div> </div> + <div class="headertitle"><div class="title">Compound and Enumeration Datatypes<div class="ingroups"><a class="el" href="group___h5_t.html">Datatypes (H5T)</a></div></div></div> </div><!--header--> <div class="contents"> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> - <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Compound and Enumeration Datatypes:</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="group___c_o_m_p_e_n_u_m.png" border="0" usemap="#agroup______c__o__m__p__e__n__u__m" alt=""/></div> -<map name="agroup______c__o__m__p__e__n__u__m" id="agroup______c__o__m__p__e__n__u__m"> -<area shape="rect" href="group___h5_t.html" title=" " alt="" coords="5,31,135,56"/> -<area shape="rect" title=" " alt="" coords="183,23,389,63"/> -<area shape="rect" href="group___e_n_u_m.html" title=" " alt="" coords="437,5,613,31"/> -<area shape="rect" href="group___c_o_m_p_o_u_n_d.html" title=" " alt="" coords="444,55,607,80"/> -</map> -</div> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> -Modules</h2></td></tr> -<tr class="memitem:group___c_o_m_p_o_u_n_d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_m_p_o_u_n_d.html">Compound Datatypes</a></td></tr> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a> +Topics</h2></td></tr> +<tr class="memitem:group___c_o_m_p_o_u_n_d" id="r_group___c_o_m_p_o_u_n_d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_m_p_o_u_n_d.html">Compound Datatypes</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:group___e_n_u_m"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_n_u_m.html">Enumeration Datatypes</a></td></tr> +<tr class="memitem:group___e_n_u_m" id="r_group___e_n_u_m"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_n_u_m.html">Enumeration Datatypes</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:ga21bdfc706f71ebe298a433e74b5bc626"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_m_p_e_n_u_m.html#ga21bdfc706f71ebe298a433e74b5bc626">H5Tget_nmembers</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:ga21bdfc706f71ebe298a433e74b5bc626"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of elements in a compound or enumeration datatype. <a href="group___c_o_m_p_e_n_u_m.html#ga21bdfc706f71ebe298a433e74b5bc626">More...</a><br /></td></tr> +<tr class="memitem:ga21bdfc706f71ebe298a433e74b5bc626" id="r_ga21bdfc706f71ebe298a433e74b5bc626"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga21bdfc706f71ebe298a433e74b5bc626">H5Tget_nmembers</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> +<tr class="memdesc:ga21bdfc706f71ebe298a433e74b5bc626"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of elements in a compound or enumeration datatype. <br /></td></tr> <tr class="separator:ga21bdfc706f71ebe298a433e74b5bc626"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaef6b68436eba0fca751968ebf057ade3"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_m_p_e_n_u_m.html#gaef6b68436eba0fca751968ebf057ade3">H5Tget_member_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, unsigned membno)</td></tr> -<tr class="memdesc:gaef6b68436eba0fca751968ebf057ade3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the name of a compound or enumeration datatype member. <a href="group___c_o_m_p_e_n_u_m.html#gaef6b68436eba0fca751968ebf057ade3">More...</a><br /></td></tr> -<tr class="separator:gaef6b68436eba0fca751968ebf057ade3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gabe31b13b2b8bf29d1a4c3b04cf917c6c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_m_p_e_n_u_m.html#gabe31b13b2b8bf29d1a4c3b04cf917c6c">H5Tget_member_index</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, const char *name)</td></tr> -<tr class="memdesc:gabe31b13b2b8bf29d1a4c3b04cf917c6c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the index of a compound or enumeration datatype member. <a href="group___c_o_m_p_e_n_u_m.html#gabe31b13b2b8bf29d1a4c3b04cf917c6c">More...</a><br /></td></tr> +<tr class="memitem:ga64d1d807464d2011192f28115580fb66" id="r_ga64d1d807464d2011192f28115580fb66"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga64d1d807464d2011192f28115580fb66">H5Tget_member_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, unsigned membno)</td></tr> +<tr class="memdesc:ga64d1d807464d2011192f28115580fb66"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the name of a compound or enumeration datatype member. <br /></td></tr> +<tr class="separator:ga64d1d807464d2011192f28115580fb66"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabe31b13b2b8bf29d1a4c3b04cf917c6c" id="r_gabe31b13b2b8bf29d1a4c3b04cf917c6c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabe31b13b2b8bf29d1a4c3b04cf917c6c">H5Tget_member_index</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, const char *name)</td></tr> +<tr class="memdesc:gabe31b13b2b8bf29d1a4c3b04cf917c6c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the index of a compound or enumeration datatype member. <br /></td></tr> <tr class="separator:gabe31b13b2b8bf29d1a4c3b04cf917c6c"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Function Documentation</h2> -<a id="gabe31b13b2b8bf29d1a4c3b04cf917c6c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gabe31b13b2b8bf29d1a4c3b04cf917c6c">◆ </a></span>H5Tget_member_index()</h2> +<a id="gabe31b13b2b8bf29d1a4c3b04cf917c6c" name="gabe31b13b2b8bf29d1a4c3b04cf917c6c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabe31b13b2b8bf29d1a4c3b04cf917c6c">◆ </a></span>H5Tget_member_index()</h2> <div class="memitem"> <div class="memproto"> @@ -150,19 +141,12 @@ Functions</h2></td></tr> <tr> <td class="memname">int H5Tget_member_index </td> <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>type_id</em>, </td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>type_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>name</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -176,35 +160,28 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___c_o_m_p_e_n_u_m.html#gabe31b13b2b8bf29d1a4c3b04cf917c6c" title="Retrieves the index of a compound or enumeration datatype member.">H5Tget_member_index()</a> retrieves the index of a field of a compound datatype or an element of an enumeration datatype.</p> +<p><a class="el" href="#gabe31b13b2b8bf29d1a4c3b04cf917c6c" title="Retrieves the index of a compound or enumeration datatype member.">H5Tget_member_index()</a> retrieves the index of a field of a compound datatype or an element of an enumeration datatype.</p> <p>The name of the target field or element is specified by <code>name</code>.</p> -<p>Fields are stored in no particular order with index values of 0 through N-1, where N is the value returned by <a class="el" href="group___c_o_m_p_e_n_u_m.html#ga21bdfc706f71ebe298a433e74b5bc626" title="Retrieves the number of elements in a compound or enumeration datatype.">H5Tget_nmembers()</a> .</p> +<p>Fields are stored in no particular order with index values of 0 through N-1, where N is the value returned by <a class="el" href="#ga21bdfc706f71ebe298a433e74b5bc626" title="Retrieves the number of elements in a compound or enumeration datatype.">H5Tget_nmembers()</a> .</p> <dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl> </div> </div> -<a id="gaef6b68436eba0fca751968ebf057ade3"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaef6b68436eba0fca751968ebf057ade3">◆ </a></span>H5Tget_member_name()</h2> +<a id="ga64d1d807464d2011192f28115580fb66" name="ga64d1d807464d2011192f28115580fb66"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga64d1d807464d2011192f28115580fb66">◆ </a></span>H5Tget_member_name()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">char* H5Tget_member_name </td> + <td class="memname">char * H5Tget_member_name </td> <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>type_id</em>, </td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>type_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned </td> - <td class="paramname"><em>membno</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>membno</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -218,15 +195,15 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a valid pointer to a string allocated with malloc() if successful; otherwise returns NULL.</dd></dl> -<p><a class="el" href="group___c_o_m_p_e_n_u_m.html#gaef6b68436eba0fca751968ebf057ade3" title="Retrieves the name of a compound or enumeration datatype member.">H5Tget_member_name()</a> retrieves the name of a field of a compound datatype or an element of an enumeration datatype.</p> -<p>The index of the target field or element is specified in <code>member_no</code>. Compound datatype fields and enumeration datatype elements are stored in no particular order with index values of 0 through N-1, where N is the value returned by <a class="el" href="group___c_o_m_p_e_n_u_m.html#ga21bdfc706f71ebe298a433e74b5bc626" title="Retrieves the number of elements in a compound or enumeration datatype.">H5Tget_nmembers()</a>.</p> +<p><a class="el" href="#ga64d1d807464d2011192f28115580fb66" title="Retrieves the name of a compound or enumeration datatype member.">H5Tget_member_name()</a> retrieves the name of a field of a compound datatype or an element of an enumeration datatype.</p> +<p>The index of the target field or element is specified in <code>member_no</code>. Compound datatype fields and enumeration datatype elements are stored in no particular order with index values of 0 through N-1, where N is the value returned by <a class="el" href="#ga21bdfc706f71ebe298a433e74b5bc626" title="Retrieves the number of elements in a compound or enumeration datatype.">H5Tget_nmembers()</a>.</p> <p>The HDF5 library allocates a buffer to receive the name of the field. The caller must subsequently free the buffer with <a class="el" href="group___h5.html#ga71872bf6445cba956da86d4762b662cf" title="Frees memory allocated by the HDF5 library.">H5free_memory()</a>.</p> <dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> -<a id="ga21bdfc706f71ebe298a433e74b5bc626"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga21bdfc706f71ebe298a433e74b5bc626">◆ </a></span>H5Tget_nmembers()</h2> +<a id="ga21bdfc706f71ebe298a433e74b5bc626" name="ga21bdfc706f71ebe298a433e74b5bc626"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga21bdfc706f71ebe298a433e74b5bc626">◆ </a></span>H5Tget_nmembers()</h2> <div class="memitem"> <div class="memproto"> @@ -234,8 +211,7 @@ Functions</h2></td></tr> <tr> <td class="memname">int H5Tget_nmembers </td> <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>type_id</em></td><td>)</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>type_id</em></span></td><td>)</td> <td></td> </tr> </table> @@ -249,7 +225,7 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns the number of elements if successful; otherwise returns a negative value.</dd></dl> -<p><a class="el" href="group___c_o_m_p_e_n_u_m.html#ga21bdfc706f71ebe298a433e74b5bc626" title="Retrieves the number of elements in a compound or enumeration datatype.">H5Tget_nmembers()</a> retrieves the number of fields in a compound datatype or the number of members of an enumeration datatype.</p> +<p><a class="el" href="#ga21bdfc706f71ebe298a433e74b5bc626" title="Retrieves the number of elements in a compound or enumeration datatype.">H5Tget_nmembers()</a> retrieves the number of fields in a compound datatype or the number of members of an enumeration datatype.</p> <dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> @@ -261,7 +237,7 @@ Functions</h2></td></tr> <ul> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li> </ul> </div> </body> |