diff options
| author | lrknox <lrknox@users.noreply.github.com> | 2023-11-03 00:48:38 (GMT) |
|---|---|---|
| committer | lrknox <lrknox@users.noreply.github.com> | 2023-11-03 00:48:38 (GMT) |
| commit | cc9f909207d012b868e3ce3a69460b1035650de5 (patch) | |
| tree | 4a6ec26c10acb158c549d0130bf3201d3f4d1eb1 /v1_14/group___h5_t.html | |
| parent | 3a692d7d114a845a25bd1e19ca40af7a89e99c1c (diff) | |
| download | hdf5-cc9f909207d012b868e3ce3a69460b1035650de5.zip hdf5-cc9f909207d012b868e3ce3a69460b1035650de5.tar.gz hdf5-cc9f909207d012b868e3ce3a69460b1035650de5.tar.bz2 | |
deploy: 61982b60fd5e3a29044a1cdd1931b0ab9f96dec1
Diffstat (limited to 'v1_14/group___h5_t.html')
| -rw-r--r-- | v1_14/group___h5_t.html | 1396 |
1 files changed, 0 insertions, 1396 deletions
diff --git a/v1_14/group___h5_t.html b/v1_14/group___h5_t.html deleted file mode 100644 index 27e7913..0000000 --- a/v1_14/group___h5_t.html +++ /dev/null @@ -1,1396 +0,0 @@ -<!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: Datatypes (H5T)</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.14.4.61aef8d</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('group___h5_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"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="summary"> -<a href="#groups">Modules</a> | -<a href="#define-members">Macros</a> | -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Datatypes (H5T)</div> </div> -</div><!--header--> -<div class="contents"> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Use the functions in this module to manage HDF5 datatypes.</p> -<p>HDF5 datatypes describe the element type of HDF5 datasets and attributes. There's a large set of predefined datatypes, but users may find it useful to define new datatypes through a process called <em>derivation</em>.</p> -<p>The element type is automatically persisted as part of the HDF5 metadata of attributes and datasets. Additionally, datatype definitions can be persisted to HDF5 files and linked to groups as HDF5 datatype objects or so-called <em>committed datatypes</em>. </p> -<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 Datatypes (H5T):</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___h5_t.png" border="0" usemap="#agroup______h5__t" alt=""/></div> -<map name="agroup______h5__t" id="agroup______h5__t"> -<area shape="rect" title=" " alt="" coords="5,153,135,179"/> -<area shape="rect" href="group___c_o_n_v.html" title=" " alt="" coords="209,5,363,31"/> -<area shape="rect" href="group___p_d_t.html" title=" " alt="" coords="205,55,367,80"/> -<area shape="rect" href="group___a_t_o_m.html" title=" " alt="" coords="217,104,355,129"/> -<area shape="rect" href="group___o_p_a_q_u_e.html" title=" " alt="" coords="215,153,357,179"/> -<area shape="rect" href="group___v_l_e_n.html" title=" " alt="" coords="192,203,380,243"/> -<area shape="rect" href="group___a_r_r_a_y.html" title=" " alt="" coords="222,268,350,293"/> -<area shape="rect" href="group___c_o_m_p_e_n_u_m.html" title=" " alt="" coords="183,318,389,358"/> -</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___a_r_r_a_y"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_r_r_a_y.html">Array Datatypes</a></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:group___a_t_o_m"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_t_o_m.html">Atomic Datatypes</a></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:group___c_o_m_p_e_n_u_m"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_m_p_e_n_u_m.html">Compound and Enumeration Datatypes</a></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:group___c_o_n_v"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_n_v.html">Conversion Function</a></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:group___o_p_a_q_u_e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___o_p_a_q_u_e.html">Opaque Datatypes</a></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:group___p_d_t"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_d_t.html">Predefined Datatypes</a></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:group___v_l_e_n"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___v_l_e_n.html">Variable-length Sequence 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="define-members"></a> -Macros</h2></td></tr> -<tr class="memitem:ga9a224eb59f0ba807789e3f8ba3a840cd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit</a>   <a class="el" href="group___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31">H5Tcommit2</a></td></tr> -<tr class="separator:ga9a224eb59f0ba807789e3f8ba3a840cd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga1d14b407603fdcedfbed1f723784c209"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga1d14b407603fdcedfbed1f723784c209">H5Topen</a>   <a class="el" href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2">H5Topen2</a></td></tr> -<tr class="separator:ga1d14b407603fdcedfbed1f723784c209"><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> -Functions</h2></td></tr> -<tr class="memitem:gaa9afc38e1a7d35e4d0bec24c569b3c65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#gaa9afc38e1a7d35e4d0bec24c569b3c65">H5Tcreate</a> (<a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a> type, size_t size)</td></tr> -<tr class="memdesc:gaa9afc38e1a7d35e4d0bec24c569b3c65"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new datatype. <a href="group___h5_t.html#gaa9afc38e1a7d35e4d0bec24c569b3c65">More...</a><br /></td></tr> -<tr class="separator:gaa9afc38e1a7d35e4d0bec24c569b3c65"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaec07efbab84f4e5b4ed22f010786be8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#gaec07efbab84f4e5b4ed22f010786be8e">H5Tcopy</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:gaec07efbab84f4e5b4ed22f010786be8e"><td class="mdescLeft"> </td><td class="mdescRight">Copies an existing datatype. <a href="group___h5_t.html#gaec07efbab84f4e5b4ed22f010786be8e">More...</a><br /></td></tr> -<tr class="separator:gaec07efbab84f4e5b4ed22f010786be8e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gafcba4db244f6a4d71e99c6e72b8678f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0">H5Tclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:gafcba4db244f6a4d71e99c6e72b8678f0"><td class="mdescLeft"> </td><td class="mdescRight">Releases a datatype. <a href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0">More...</a><br /></td></tr> -<tr class="separator:gafcba4db244f6a4d71e99c6e72b8678f0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga2da609983e073f83bcd0d8eff8b528ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga2da609983e073f83bcd0d8eff8b528ff">H5Tclose_async</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id)</td></tr> -<tr class="memdesc:ga2da609983e073f83bcd0d8eff8b528ff"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronous version of <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a>. <a href="group___h5_t.html#ga2da609983e073f83bcd0d8eff8b528ff">More...</a><br /></td></tr> -<tr class="separator:ga2da609983e073f83bcd0d8eff8b528ff"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaa92250f289b557b63cba974defa20b0f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#gaa92250f289b557b63cba974defa20b0f">H5Tequal</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type1_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type2_id)</td></tr> -<tr class="memdesc:gaa92250f289b557b63cba974defa20b0f"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether two datatype identifiers refer to the same datatype. <a href="group___h5_t.html#gaa92250f289b557b63cba974defa20b0f">More...</a><br /></td></tr> -<tr class="separator:gaa92250f289b557b63cba974defa20b0f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga523642dbf4c60a83127fff87664a965b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga523642dbf4c60a83127fff87664a965b">H5Tlock</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:ga523642dbf4c60a83127fff87664a965b"><td class="mdescLeft"> </td><td class="mdescRight">Locks a datatype. <a href="group___h5_t.html#ga523642dbf4c60a83127fff87664a965b">More...</a><br /></td></tr> -<tr class="separator:ga523642dbf4c60a83127fff87664a965b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga10352b6fa9ac58a7fbd5299496f1df31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31">H5Tcommit2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id)</td></tr> -<tr class="memdesc:ga10352b6fa9ac58a7fbd5299496f1df31"><td class="mdescLeft"> </td><td class="mdescRight">Commits a transient datatype, linking it into the file and creating a new committed datatype. <a href="group___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31">More...</a><br /></td></tr> -<tr class="separator:ga10352b6fa9ac58a7fbd5299496f1df31"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga4d0466c9f9762e184e03fdbdb2855ead"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga4d0466c9f9762e184e03fdbdb2855ead">H5Tcommit_async</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id)</td></tr> -<tr class="memdesc:ga4d0466c9f9762e184e03fdbdb2855ead"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronous version of <a class="el" href="group___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31" title="Commits a transient datatype, linking it into the file and creating a new committed datatype.">H5Tcommit2()</a>. <a href="group___h5_t.html#ga4d0466c9f9762e184e03fdbdb2855ead">More...</a><br /></td></tr> -<tr class="separator:ga4d0466c9f9762e184e03fdbdb2855ead"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga7e65e77634f1fb4ba38cbcdab9a59bc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2">H5Topen2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id)</td></tr> -<tr class="memdesc:ga7e65e77634f1fb4ba38cbcdab9a59bc2"><td class="mdescLeft"> </td><td class="mdescRight">Opens a committed (named) datatype. <a href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2">More...</a><br /></td></tr> -<tr class="separator:ga7e65e77634f1fb4ba38cbcdab9a59bc2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gad92e4af6b8ac52712fb4238281f921e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#gad92e4af6b8ac52712fb4238281f921e9">H5Topen_async</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id)</td></tr> -<tr class="memdesc:gad92e4af6b8ac52712fb4238281f921e9"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronous version of <a class="el" href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2" title="Opens a committed (named) datatype.">H5Topen2()</a>. <a href="group___h5_t.html#gad92e4af6b8ac52712fb4238281f921e9">More...</a><br /></td></tr> -<tr class="separator:gad92e4af6b8ac52712fb4238281f921e9"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga510d2e4ab51247ab1a915be701001581"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581">H5Tcommit_anon</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id)</td></tr> -<tr class="memdesc:ga510d2e4ab51247ab1a915be701001581"><td class="mdescLeft"> </td><td class="mdescRight">Commits a transient datatype to a file, creating a newly named datatype, but does not link it into the file structure. <a href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581">More...</a><br /></td></tr> -<tr class="separator:ga510d2e4ab51247ab1a915be701001581"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6802c22c6e90216aa839a4a83909a54c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga6802c22c6e90216aa839a4a83909a54c">H5Tget_create_plist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:ga6802c22c6e90216aa839a4a83909a54c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of a datatype's creation property list. <a href="group___h5_t.html#ga6802c22c6e90216aa839a4a83909a54c">More...</a><br /></td></tr> -<tr class="separator:ga6802c22c6e90216aa839a4a83909a54c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga0eba38d8c49784269e71ac9fa79b0f0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga0eba38d8c49784269e71ac9fa79b0f0a">H5Tcommitted</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:ga0eba38d8c49784269e71ac9fa79b0f0a"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a datatype is a committed type or a transient type. <a href="group___h5_t.html#ga0eba38d8c49784269e71ac9fa79b0f0a">More...</a><br /></td></tr> -<tr class="separator:ga0eba38d8c49784269e71ac9fa79b0f0a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga1ceda41ee462fab8dd70bdf67205ed1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga1ceda41ee462fab8dd70bdf67205ed1c">H5Tencode</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, void *buf, size_t *nalloc)</td></tr> -<tr class="memdesc:ga1ceda41ee462fab8dd70bdf67205ed1c"><td class="mdescLeft"> </td><td class="mdescRight">Encodes a datatype object description into a binary buffer. <a href="group___h5_t.html#ga1ceda41ee462fab8dd70bdf67205ed1c">More...</a><br /></td></tr> -<tr class="separator:ga1ceda41ee462fab8dd70bdf67205ed1c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga186d7ed91fc0f9c55e19dcd96c7b229b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga186d7ed91fc0f9c55e19dcd96c7b229b">H5Tdecode</a> (const void *buf)</td></tr> -<tr class="memdesc:ga186d7ed91fc0f9c55e19dcd96c7b229b"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a binary object description of datatype and returns a new object handle. <a href="group___h5_t.html#ga186d7ed91fc0f9c55e19dcd96c7b229b">More...</a><br /></td></tr> -<tr class="separator:ga186d7ed91fc0f9c55e19dcd96c7b229b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gafd60389b49e1e5e6f37caffbe6cbf6e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#gafd60389b49e1e5e6f37caffbe6cbf6e5">H5Tflush</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:gafd60389b49e1e5e6f37caffbe6cbf6e5"><td class="mdescLeft"> </td><td class="mdescRight">Flushes all buffers associated with a committed datatype to disk. <a href="group___h5_t.html#gafd60389b49e1e5e6f37caffbe6cbf6e5">More...</a><br /></td></tr> -<tr class="separator:gafd60389b49e1e5e6f37caffbe6cbf6e5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga5bc56f6b85e114829dc12d6b18d66f4d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga5bc56f6b85e114829dc12d6b18d66f4d">H5Trefresh</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:ga5bc56f6b85e114829dc12d6b18d66f4d"><td class="mdescLeft"> </td><td class="mdescRight">Refreshes all buffers associated with a committed datatype. <a href="group___h5_t.html#ga5bc56f6b85e114829dc12d6b18d66f4d">More...</a><br /></td></tr> -<tr class="separator:ga5bc56f6b85e114829dc12d6b18d66f4d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga331e8f7b388a50af77294018db788de3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga331e8f7b388a50af77294018db788de3">H5Tget_super</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type)</td></tr> -<tr class="memdesc:ga331e8f7b388a50af77294018db788de3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the base datatype from which a datatype is derived. <a href="group___h5_t.html#ga331e8f7b388a50af77294018db788de3">More...</a><br /></td></tr> -<tr class="separator:ga331e8f7b388a50af77294018db788de3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga364545c053f925fec65880b235e37898"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga364545c053f925fec65880b235e37898">H5Tget_class</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:ga364545c053f925fec65880b235e37898"><td class="mdescLeft"> </td><td class="mdescRight">Returns a datatype class. <a href="group___h5_t.html#ga364545c053f925fec65880b235e37898">More...</a><br /></td></tr> -<tr class="separator:ga364545c053f925fec65880b235e37898"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaf0bffa3c338853565f24f29c0f090692"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#gaf0bffa3c338853565f24f29c0f090692">H5Tdetect_class</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a> cls)</td></tr> -<tr class="memdesc:gaf0bffa3c338853565f24f29c0f090692"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a datatype contains any datatypes of the given datatype class. <a href="group___h5_t.html#gaf0bffa3c338853565f24f29c0f090692">More...</a><br /></td></tr> -<tr class="separator:gaf0bffa3c338853565f24f29c0f090692"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga1b971589cd7a86f3e84affdee455564e"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga1b971589cd7a86f3e84affdee455564e">H5Tget_size</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:ga1b971589cd7a86f3e84affdee455564e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of a datatype. <a href="group___h5_t.html#ga1b971589cd7a86f3e84affdee455564e">More...</a><br /></td></tr> -<tr class="separator:ga1b971589cd7a86f3e84affdee455564e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga05b99133058637e8daa5d745381ddd3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga05b99133058637e8daa5d745381ddd3d">H5Tget_native_type</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33d">H5T_direction_t</a> direction)</td></tr> -<tr class="memdesc:ga05b99133058637e8daa5d745381ddd3d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the native datatype identifier of a specified datatype. <a href="group___h5_t.html#ga05b99133058637e8daa5d745381ddd3d">More...</a><br /></td></tr> -<tr class="separator:ga05b99133058637e8daa5d745381ddd3d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gae5f38bfd4a4c557496b3194b5180212c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#gae5f38bfd4a4c557496b3194b5180212c">H5Tset_size</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, size_t size)</td></tr> -<tr class="memdesc:gae5f38bfd4a4c557496b3194b5180212c"><td class="mdescLeft"> </td><td class="mdescRight">Sets size for a datatype. <a href="group___h5_t.html#gae5f38bfd4a4c557496b3194b5180212c">More...</a><br /></td></tr> -<tr class="separator:gae5f38bfd4a4c557496b3194b5180212c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga1c00afb6dc5534778370a92c33fa2625"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga1c00afb6dc5534778370a92c33fa2625">H5Tcommit1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id)</td></tr> -<tr class="memdesc:ga1c00afb6dc5534778370a92c33fa2625"><td class="mdescLeft"> </td><td class="mdescRight">Commits a transient datatype to a file, creating a newly named datatype. <a href="group___h5_t.html#ga1c00afb6dc5534778370a92c33fa2625">More...</a><br /></td></tr> -<tr class="separator:ga1c00afb6dc5534778370a92c33fa2625"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga9f76fa0dc34bc7b310e100e5bfed66fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_t.html#ga9f76fa0dc34bc7b310e100e5bfed66fb">H5Topen1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name)</td></tr> -<tr class="memdesc:ga9f76fa0dc34bc7b310e100e5bfed66fb"><td class="mdescLeft"> </td><td class="mdescRight">Opens a named datatype. <a href="group___h5_t.html#ga9f76fa0dc34bc7b310e100e5bfed66fb">More...</a><br /></td></tr> -<tr class="separator:ga9f76fa0dc34bc7b310e100e5bfed66fb"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<h2 class="groupheader">Macro Definition Documentation</h2> -<a id="ga9a224eb59f0ba807789e3f8ba3a840cd"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga9a224eb59f0ba807789e3f8ba3a840cd">◆ </a></span>H5Tcommit</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">#define H5Tcommit   <a class="el" href="group___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31">H5Tcommit2</a></td> - </tr> - </table> -</div><div class="memdoc"> -<p><a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit()</a> is a macro that is mapped to either <a class="el" href="group___h5_t.html#ga1c00afb6dc5534778370a92c33fa2625" title="Commits a transient datatype to a file, creating a newly named datatype.">H5Tcommit1()</a> or <a class="el" href="group___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31" title="Commits a transient datatype, linking it into the file and creating a new committed datatype.">H5Tcommit2()</a>.<br /> -</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl> - -</div> -</div> -<a id="ga1d14b407603fdcedfbed1f723784c209"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga1d14b407603fdcedfbed1f723784c209">◆ </a></span>H5Topen</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">#define H5Topen   <a class="el" href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2">H5Topen2</a></td> - </tr> - </table> -</div><div class="memdoc"> -<p><a class="el" href="group___h5_t.html#ga1d14b407603fdcedfbed1f723784c209">H5Topen()</a> is a macro that is mapped to either <a class="el" href="group___h5_t.html#ga9f76fa0dc34bc7b310e100e5bfed66fb" title="Opens a named datatype.">H5Topen1()</a> or <a class="el" href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2" title="Opens a committed (named) datatype.">H5Topen2()</a>.<br /> -</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl> - -</div> -</div> -<h2 class="groupheader">Function Documentation</h2> -<a id="gafcba4db244f6a4d71e99c6e72b8678f0"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gafcba4db244f6a4d71e99c6e72b8678f0">◆ </a></span>H5Tclose()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tclose </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></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Releases a datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier</td></tr> - </table> - </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___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a> releases the datatype <code>dtype_id</code>. Further access through this datatype identifier is illegal. Failure to release a datatype with this call will result in resource leaks. </p> - -</div> -</div> -<a id="ga2da609983e073f83bcd0d8eff8b528ff"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga2da609983e073f83bcd0d8eff8b528ff">◆ </a></span>H5Tclose_async()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tclose_async </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> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>es_id</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Asynchronous version of <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a>. </p> - -</div> -</div> -<a id="ga1c00afb6dc5534778370a92c33fa2625"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga1c00afb6dc5534778370a92c33fa2625">◆ </a></span>H5Tcommit1()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tcommit1 </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>loc_id</em>, </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 class="paramkey"></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> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Commits a transient datatype to a file, creating a newly named datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name given to committed datatype </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Identifier of datatype to be committed</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000084">Deprecated:</a></b></dt><dd>This function has been renamed from <a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit()</a> and is deprecated in favor of the macro <a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit</a> or the function <a class="el" href="group___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31" title="Commits a transient datatype, linking it into the file and creating a new committed datatype.">H5Tcommit2()</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga1c00afb6dc5534778370a92c33fa2625" title="Commits a transient datatype to a file, creating a newly named datatype.">H5Tcommit1()</a> commits the transient datatype (not immutable) to a file, turning it into a named datatype.</p> -<p>The datatype <code>dtype_id</code> is committed as a named datatype at the location <code>loc_id</code>, which is either a file or group identifier, with the name <code>name</code>.</p> -<p><code>name</code> can be a relative path based at <code>loc_id</code> or an absolute path from the root of the file. Use of this function requires that any intermediate groups specified in the path already exist.</p> -<p>As is the case for any object in a group, the length of the name of a named datatype is not limited.</p> -<p>See <a class="el" href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581" title="Commits a transient datatype to a file, creating a newly named datatype, but does not link it into th...">H5Tcommit_anon()</a> for a discussion of the differences between <a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit()</a> and <a class="el" href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581" title="Commits a transient datatype to a file, creating a newly named datatype, but does not link it into th...">H5Tcommit_anon()</a>.</p> -<p>This function will not accept a datatype that cannot actually hold data. This currently includes compound datatypes with no fields and enumerated datatypes with no members.</p> -<dl class="section version"><dt>Version</dt><dd>1.8.7 Function modified in this release to reject datatypes that will not accommodate actual data, such as a compound datatype with no fields or an enumerated datatype with no members. </dd> -<dd> -1.8.0 C function <a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit()</a> renamed to <a class="el" href="group___h5_t.html#ga1c00afb6dc5534778370a92c33fa2625" title="Commits a transient datatype to a file, creating a newly named datatype.">H5Tcommit1()</a> and deprecated in this release. </dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> - -</div> -</div> -<a id="ga10352b6fa9ac58a7fbd5299496f1df31"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga10352b6fa9ac58a7fbd5299496f1df31">◆ </a></span>H5Tcommit2()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tcommit2 </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>loc_id</em>, </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 class="paramkey"></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> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>lcpl_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>tcpl_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>tapl_id</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Commits a transient datatype, linking it into the file and creating a new committed datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name given to committed datatype </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier Identifier of datatype to be committed and, upon function's return, identifier for the committed datatype </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation property list identifier </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">tcpl_id</td><td>Datatype creation property list identifier </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">tapl_id</td><td>Datatype access property list identifier</td></tr> - </table> - </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___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31" title="Commits a transient datatype, linking it into the file and creating a new committed datatype.">H5Tcommit2()</a> saves a transient datatype as an immutable committed datatype in a file. The datatype specified by <code>dtype_id</code> is committed to the file with the name name at the location specified by <code>loc_id</code> and with the datatype creation and access property lists <code>tcpl_id</code> and <code>tapl_id</code>, respectively.</p> -<p><code>loc_id</code> may be a file identifier, or a group identifier within that file. <code>name</code> may be either an absolute path in the file or a relative path from <code>loc_id</code> naming the newly-committed datatype.</p> -<p>The link creation property list, <code>lcpl_id</code>, governs creation of the link(s) by which the new committed datatype is accessed and the creation of any intermediate groups that may be missing.</p> -<p>Once committed, this datatype may be used to define the datatype of any other dataset or attribute in the file.</p> -<p>This function will not accept a datatype that cannot actually hold information. This currently includes compound datatypes with no fields and enumerated datatypes with no members.</p> -<p>Committed datatypes are sometimes referred to as named datatypes.</p> -<dl class="section version"><dt>Version</dt><dd>1.8.7 Function modified in this release to reject datatypes that will not accommodate actual data, such as a compound datatype with no fields or an enumerated datatype with no members.</dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> - -</div> -</div> -<a id="ga510d2e4ab51247ab1a915be701001581"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga510d2e4ab51247ab1a915be701001581">◆ </a></span>H5Tcommit_anon()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tcommit_anon </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>loc_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></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> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>tcpl_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>tapl_id</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Commits a transient datatype to a file, creating a newly named datatype, but does not link it into the file structure. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">tcpl_id</td><td>Datatype creation property list identifier </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">tapl_id</td><td>Datatype access property list identifier</td></tr> - </table> - </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___h5_t.html#ga510d2e4ab51247ab1a915be701001581" title="Commits a transient datatype to a file, creating a newly named datatype, but does not link it into th...">H5Tcommit_anon()</a> commits a transient datatype (not immutable) to a file, turning it into a named datatype with the specified creation and property lists. With default property lists, <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="el" href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581" title="Commits a transient datatype to a file, creating a newly named datatype, but does not link it into th...">H5Tcommit_anon()</a> provides similar functionality to that of <a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit()</a>, with the differences described below.</p> -<p><a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> can be passed in for the datatype creation property list identifier, <code>tcpl_id</code>. The datatype access property list identifier, <code>tapl_id</code>, is provided for future functionality and is not used at this time. This parameter should always be passed as the value <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p> -<p>Note that <a class="el" href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581" title="Commits a transient datatype to a file, creating a newly named datatype, but does not link it into th...">H5Tcommit_anon()</a> does not link this newly-committed datatype into the file. After the <a class="el" href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581" title="Commits a transient datatype to a file, creating a newly named datatype, but does not link it into th...">H5Tcommit_anon()</a> call, the datatype identifier <code>type_id</code> must be linked into the HDF5 file structure with <a class="el" href="group___h5_o.html#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink()</a> or it will be deleted from the file when the file is closed.</p> -<p>The differences between this function and <a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit()</a> are as follows: </p><ul> -<li><a class="el" href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581" title="Commits a transient datatype to a file, creating a newly named datatype, but does not link it into th...">H5Tcommit_anon()</a> explicitly includes property lists, which provides for greater control of the creation process and of the properties of the new named datatype. <a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit()</a> always uses default properties. </li> -<li><a class="el" href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581" title="Commits a transient datatype to a file, creating a newly named datatype, but does not link it into th...">H5Tcommit_anon()</a> neither provides the new named datatype's name nor links it into the HDF5 file structure; those actions must be performed separately through a call to <a class="el" href="group___h5_o.html#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink()</a>, which offers greater control over linking.</li> -</ul> -<p>This function will not accept a datatype that cannot actually hold data. This currently includes compound datatypes with no fields and enumerated datatypes with no members.</p> -<dl class="section version"><dt>Version</dt><dd>1.8.7 Function modified in this release to reject datatypes that will not accommodate actual data, such as a compound datatype with no fields or an enumerated datatype with no members.</dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> - -</div> -</div> -<a id="ga4d0466c9f9762e184e03fdbdb2855ead"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga4d0466c9f9762e184e03fdbdb2855ead">◆ </a></span>H5Tcommit_async()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tcommit_async </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>loc_id</em>, </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 class="paramkey"></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> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>lcpl_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>tcpl_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>tapl_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>es_id</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Asynchronous version of <a class="el" href="group___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31" title="Commits a transient datatype, linking it into the file and creating a new committed datatype.">H5Tcommit2()</a>. </p> - -</div> -</div> -<a id="ga0eba38d8c49784269e71ac9fa79b0f0a"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga0eba38d8c49784269e71ac9fa79b0f0a">◆ </a></span>H5Tcommitted()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Tcommitted </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></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Determines whether a datatype is a committed type or a transient type. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga0eba38d8c49784269e71ac9fa79b0f0a" title="Determines whether a datatype is a committed type or a transient type.">H5Tcommitted()</a> queries a type to determine whether the type specified by the <code>dtype_id</code> identifier is a committed (formerly known as a <em>named</em>) type or a transient type. If this function returns a positive value, then the type is committed (that is, it has been committed, perhaps by some other application). Datasets which return committed datatypes with <a class="el" href="group___h5_d.html#ga7cd04b8332e8a0939b9973fbc500cadb" title="Returns an identifier for a copy of the datatype for a dataset.">H5Dget_type()</a> are able to share the datatype with other datasets in the same file.</p> -<dl class="section version"><dt>Version</dt><dd>1.8.0 Fortran API was added</dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.6 or earlier </dd></dl> - -</div> -</div> -<a id="gaec07efbab84f4e5b4ed22f010786be8e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaec07efbab84f4e5b4ed22f010786be8e">◆ </a></span>H5Tcopy()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Tcopy </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></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Copies an existing datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns a datatype identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#gaec07efbab84f4e5b4ed22f010786be8e" title="Copies an existing datatype.">H5Tcopy()</a> makes a copy of an existing datatype. The returned type is always transient and unlocked.</p> -<p>The <code>type_id</code> argument can be either a datatype identifier, a predefined datatype (defined in <a class="el" href="_h5_tpublic_8h.html">H5Tpublic.h</a>), or a dataset identifier. If <code>type_id</code> is a dataset identifier, this function returns a transient, modifiable datatype which is a copy of the dataset's datatype.</p> -<p>The returned datatype identifier should be released with <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a> to prevent resource leaks. </p> - -</div> -</div> -<a id="gaa9afc38e1a7d35e4d0bec24c569b3c65"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaa9afc38e1a7d35e4d0bec24c569b3c65">◆ </a></span>H5Tcreate()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Tcreate </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a> </td> - <td class="paramname"><em>type</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">size_t </td> - <td class="paramname"><em>size</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Creates a new datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Class of datatype to create </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size, in bytes, of the datatype being created</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns a datatype identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#gaa9afc38e1a7d35e4d0bec24c569b3c65" title="Creates a new datatype.">H5Tcreate()</a> creates a new datatype of the specified class with the specified number of bytes. This function is used only with the following datatype classes:</p><ul> -<li><a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a7a401c61604dc846dbd3f9eb6fcb0fe6">H5T_COMPOUND</a></li> -<li><a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aaf11325a64ed5369e88d8d0d600b5cce">H5T_OPAQUE</a></li> -<li><a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5ee305303f12787367ac271d8f28f2e6">H5T_ENUM</a></li> -<li><a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2de5d7919fe54466b7cf6a6c0b4265fa">H5T_STRING</a></li> -</ul> -<p>Other datatypes, including integer and floating-point datatypes, are typically created by using <a class="el" href="group___h5_t.html#gaec07efbab84f4e5b4ed22f010786be8e" title="Copies an existing datatype.">H5Tcopy()</a> to copy and modify a predefined datatype.</p> -<p>When creating a variable-length string datatype, <code>size</code> must be <a class="el" href="_h5_tpublic_8h.html#a5185e14efde13b48249fe391324331bc">H5T_VARIABLE</a>; see <em>Creating variable-length string datatypes</em>.</p> -<p>When creating a fixed-length string datatype, <code>size</code> will be the length of the string in bytes. The length of the string in characters will depend on i the encoding used; see <a class="el" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc" title="Sets the character encoding used to encode link and attribute names.">H5Pset_char_encoding</a>.</p> -<p>ENUMs created with this function have a signed native integer base datatype. Use <a class="el" href="group___e_n_u_m.html#gafd8d8cfead535791b3f753d21e79991f" title="Creates a new enumeration datatype.">H5Tenum_create()</a> if a different integer base datatype is required.</p> -<p>The datatype identifier returned from this function should be released with H5Tclose or resource leaks will result.</p> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a></dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> - -</div> -</div> -<a id="ga186d7ed91fc0f9c55e19dcd96c7b229b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga186d7ed91fc0f9c55e19dcd96c7b229b">◆ </a></span>H5Tdecode()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Tdecode </td> - <td>(</td> - <td class="paramtype">const void * </td> - <td class="paramname"><em>buf</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Decodes a binary object description of datatype and returns a new object handle. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer for the datatype object to be decoded</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns a datatype identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga186d7ed91fc0f9c55e19dcd96c7b229b" title="Decodes a binary object description of datatype and returns a new object handle.">H5Tdecode()</a> Given an object description of datatype in binary in a buffer, <a class="el" href="group___h5_t.html#ga186d7ed91fc0f9c55e19dcd96c7b229b" title="Decodes a binary object description of datatype and returns a new object handle.">H5Tdecode()</a> reconstructs the HDF5 datatype object and returns a new object handle for it. The binary description of the object is encoded by <a class="el" href="group___h5_t.html#ga1ceda41ee462fab8dd70bdf67205ed1c" title="Encodes a datatype object description into a binary buffer.">H5Tencode()</a>. User is responsible for passing in the right buffer.</p> -<p>The datatype identifier returned by this function can be released with <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a> when the identifier is no longer needed so that resource leaks will not develop. </p> - -</div> -</div> -<a id="gaf0bffa3c338853565f24f29c0f090692"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaf0bffa3c338853565f24f29c0f090692">◆ </a></span>H5Tdetect_class()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Tdetect_class </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> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a> </td> - <td class="paramname"><em>cls</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Determines whether a datatype contains any datatypes of the given datatype class. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">cls</td><td>Datatype class</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl> -<p><a class="el" href="group___h5_t.html#gaf0bffa3c338853565f24f29c0f090692" title="Determines whether a datatype contains any datatypes of the given datatype class.">H5Tdetect_class()</a> determines whether the datatype specified in <code>type_id</code> contains any datatypes of the datatype class specified in <code>dtype_class</code>.</p> -<p>This function is useful primarily in recursively examining all the fields and/or base types of compound, array, and variable-length datatypes.</p> -<p>Valid class identifiers, as defined in <a class="el" href="_h5_tpublic_8h.html">H5Tpublic.h</a>, are: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a> {</div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a89ce244a6cbb3d0205291f41f08647a8">H5T_NO_CLASS</a> = -1, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aba1fc36abc23f073912e337d2291b037">H5T_INTEGER</a> = 0, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2e92f1a42a19de186a139ab8ff0745a9">H5T_FLOAT</a> = 1, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a8d3af61b1a73c5682f7f9b131754f6e3">H5T_TIME</a> = 2, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2de5d7919fe54466b7cf6a6c0b4265fa">H5T_STRING</a> = 3, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aae32f37ec15a835aa08d9277ad7ffaa2">H5T_BITFIELD</a> = 4, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aaf11325a64ed5369e88d8d0d600b5cce">H5T_OPAQUE</a> = 5, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a7a401c61604dc846dbd3f9eb6fcb0fe6">H5T_COMPOUND</a> = 6, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5850e0b9353a5e7aeb615fb943d4e9cd">H5T_REFERENCE</a> = 7, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5ee305303f12787367ac271d8f28f2e6">H5T_ENUM</a> = 8, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2ad8ff83b6b7ca22575263561221193028">H5T_VLEN</a> = 9, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a547a4451911e912127f300ab15113854">H5T_ARRAY</a> = 10, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a900b6431883be49bde07daf9263ed117">H5T_NCLASSES</a> </div> -<div class="line">} <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a>;</div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a></div><div class="ttdeci">H5T_class_t</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:30</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2a2de5d7919fe54466b7cf6a6c0b4265fa"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2de5d7919fe54466b7cf6a6c0b4265fa">H5T_STRING</a></div><div class="ttdeci">@ H5T_STRING</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:35</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2a2e92f1a42a19de186a139ab8ff0745a9"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2e92f1a42a19de186a139ab8ff0745a9">H5T_FLOAT</a></div><div class="ttdeci">@ H5T_FLOAT</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:33</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2a547a4451911e912127f300ab15113854"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a547a4451911e912127f300ab15113854">H5T_ARRAY</a></div><div class="ttdeci">@ H5T_ARRAY</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:42</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2a5850e0b9353a5e7aeb615fb943d4e9cd"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5850e0b9353a5e7aeb615fb943d4e9cd">H5T_REFERENCE</a></div><div class="ttdeci">@ H5T_REFERENCE</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:39</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2a5ee305303f12787367ac271d8f28f2e6"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5ee305303f12787367ac271d8f28f2e6">H5T_ENUM</a></div><div class="ttdeci">@ H5T_ENUM</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:40</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2a7a401c61604dc846dbd3f9eb6fcb0fe6"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a7a401c61604dc846dbd3f9eb6fcb0fe6">H5T_COMPOUND</a></div><div class="ttdeci">@ H5T_COMPOUND</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:38</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2a89ce244a6cbb3d0205291f41f08647a8"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a89ce244a6cbb3d0205291f41f08647a8">H5T_NO_CLASS</a></div><div class="ttdeci">@ H5T_NO_CLASS</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:31</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2a8d3af61b1a73c5682f7f9b131754f6e3"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a8d3af61b1a73c5682f7f9b131754f6e3">H5T_TIME</a></div><div class="ttdeci">@ H5T_TIME</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:34</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2a900b6431883be49bde07daf9263ed117"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a900b6431883be49bde07daf9263ed117">H5T_NCLASSES</a></div><div class="ttdeci">@ H5T_NCLASSES</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:44</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2aae32f37ec15a835aa08d9277ad7ffaa2"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aae32f37ec15a835aa08d9277ad7ffaa2">H5T_BITFIELD</a></div><div class="ttdeci">@ H5T_BITFIELD</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:36</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2aaf11325a64ed5369e88d8d0d600b5cce"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aaf11325a64ed5369e88d8d0d600b5cce">H5T_OPAQUE</a></div><div class="ttdeci">@ H5T_OPAQUE</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:37</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2aba1fc36abc23f073912e337d2291b037"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aba1fc36abc23f073912e337d2291b037">H5T_INTEGER</a></div><div class="ttdeci">@ H5T_INTEGER</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:32</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a071841985f647f69516dbe77d93167f2ad8ff83b6b7ca22575263561221193028"><div class="ttname"><a href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2ad8ff83b6b7ca22575263561221193028">H5T_VLEN</a></div><div class="ttdeci">@ H5T_VLEN</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:41</div></div> -</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl> - -</div> -</div> -<a id="ga1ceda41ee462fab8dd70bdf67205ed1c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga1ceda41ee462fab8dd70bdf67205ed1c">◆ </a></span>H5Tencode()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tencode </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>obj_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>buf</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">size_t * </td> - <td class="paramname"><em>nalloc</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Encodes a datatype object description into a binary buffer. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Identifier of the object to be encoded </td></tr> - <tr><td class="paramdir">[in,out]</td><td class="paramname">buf</td><td>Buffer for the object to be encoded into. </td></tr> - <tr><td class="paramdir">[in,out]</td><td class="paramname">nalloc</td><td>IN: The size of the allocated buffer OUT: The size of the buffer needed</td></tr> - </table> - </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___h5_t.html#ga1ceda41ee462fab8dd70bdf67205ed1c" title="Encodes a datatype object description into a binary buffer.">H5Tencode()</a> Given datatype identifier, <a class="el" href="group___h5_t.html#ga1ceda41ee462fab8dd70bdf67205ed1c" title="Encodes a datatype object description into a binary buffer.">H5Tencode()</a> converts a datatype description into binary form in a buffer. Using this binary form in the buffer, a datatype object can be reconstructed using <a class="el" href="group___h5_t.html#ga186d7ed91fc0f9c55e19dcd96c7b229b" title="Decodes a binary object description of datatype and returns a new object handle.">H5Tdecode()</a> to return a new object handle (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>) for this datatype.</p> -<p>If the provided buffer is NULL, only the size of buffer needed is returned through <code>nalloc</code>.</p> -<p>A preliminary <a class="el" href="group___h5_t.html#ga1ceda41ee462fab8dd70bdf67205ed1c" title="Encodes a datatype object description into a binary buffer.">H5Tencode()</a> call can be made to find out the size of the buffer needed. This value is returned as <code>nalloc</code>. That value can then be assigned to <code>nalloc</code> for a second <a class="el" href="group___h5_t.html#ga1ceda41ee462fab8dd70bdf67205ed1c" title="Encodes a datatype object description into a binary buffer.">H5Tencode()</a> call, which will retrieve the actual encoded object.</p> -<p>If the library finds that <code>nalloc</code> is not big enough for the object, it simply returns the size of the buffer needed through <code>nalloc</code> without encoding the provided buffer.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> - -</div> -</div> -<a id="gaa92250f289b557b63cba974defa20b0f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaa92250f289b557b63cba974defa20b0f">◆ </a></span>H5Tequal()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Tequal </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>type1_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>type2_id</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Determines whether two datatype identifiers refer to the same datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type1_id</td><td>Datatype identifier </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">type2_id</td><td>Datatype identifier</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl> -<p><a class="el" href="group___h5_t.html#gaa92250f289b557b63cba974defa20b0f" title="Determines whether two datatype identifiers refer to the same datatype.">H5Tequal()</a> determines whether two datatype identifiers refer to the same datatype.</p> -<dl class="section since"><dt>Since</dt><dd>1.6 or earlier </dd></dl> - -</div> -</div> -<a id="gafd60389b49e1e5e6f37caffbe6cbf6e5"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gafd60389b49e1e5e6f37caffbe6cbf6e5">◆ </a></span>H5Tflush()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tflush </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></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Flushes all buffers associated with a committed datatype to disk. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier</td></tr> - </table> - </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___h5_t.html#gafd60389b49e1e5e6f37caffbe6cbf6e5" title="Flushes all buffers associated with a committed datatype to disk.">H5Tflush()</a> causes all buffers associated with a committed datatype <code>type_id</code> to be immediately flushed to disk without removing the data from the cache.</p> -<p>HDF5 does not possess full control over buffering. <a class="el" href="group___h5_t.html#gafd60389b49e1e5e6f37caffbe6cbf6e5" title="Flushes all buffers associated with a committed datatype to disk.">H5Tflush()</a> flushes the internal HDF5 buffers and then asks the operating system (the OS) to flush the system buffers for the open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk.</p> -<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.10.0 C function introduced with this release.</dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_d.html#ga4a2175a62baa1e35ad2467bb1fdff1f7" title="Flushes all buffers associated with a dataset to disk.">H5Dflush()</a> <a class="el" href="group___h5_d.html#ga3c1ea7e5db3f62d9cf03dd62d1fb08da" title="Refreshes all buffers associated with a dataset.">H5Drefresh()</a> <a class="el" href="group___h5_t.html#gafd60389b49e1e5e6f37caffbe6cbf6e5" title="Flushes all buffers associated with a committed datatype to disk.">H5Tflush()</a> <a class="el" href="group___h5_g.html#ga0a8bdd0eb1b001222c27d3d39a909840" title="Refreshes all buffers associated with a group.">H5Grefresh()</a> <a class="el" href="group___h5_o.html#gad99f35048cba4534b6393214684f090f" title="Flushes all buffers associated with an HDF5 object to disk.">H5Oflush()</a> <a class="el" href="group___h5_o.html#gaf0318b68be9ab23a92b8a6bee0af9e2f" title="Refreshes all buffers associated with an HDF5 object.">H5Orefresh()</a> <a class="el" href="group___h5_t.html#gafd60389b49e1e5e6f37caffbe6cbf6e5" title="Flushes all buffers associated with a committed datatype to disk.">H5Tflush()</a> <a class="el" href="group___h5_t.html#ga5bc56f6b85e114829dc12d6b18d66f4d" title="Refreshes all buffers associated with a committed datatype.">H5Trefresh()</a> <a class="el" href="group___s_w_m_r.html#ga159be34fbe7e4a959589310ef0196dfe" title="Retrieves free-space section information for a file.">H5Fstart_swmr_write()</a> <a class="el" href="group___d_a_p_l.html#gacd6803640eebd20e408c330192b09fa6" title="Retrieves the values of the append property that is set up in the dataset access property list.">H5Pget_append_flush()</a> <a class="el" href="group___f_a_p_l.html#gadb66d434fd8d2f600213b0eec539564e" title="Retrieves the object flush property values from the file access property list.">H5Pget_object_flush_cb()</a> <a class="el" href="group___d_a_p_l.html#ga2f685a7b3f3a4fa35ddcd1659ab4a835" title="Sets two actions to perform when the size of a dataset's dimension being appended reaches a specified...">H5Pset_append_flush()</a> <a class="el" href="group___f_a_p_l.html#gab4a4a788af5b6e88381dda0df2efbf19" title="Sets a callback function to invoke when an object flush occurs in the file.">H5Pset_object_flush_cb()</a> </dd></dl> - -</div> -</div> -<a id="ga364545c053f925fec65880b235e37898"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga364545c053f925fec65880b235e37898">◆ </a></span>H5Tget_class()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a> H5Tget_class </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></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns a datatype class. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns the datatype class if successful; otherwise <a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a89ce244a6cbb3d0205291f41f08647a8">H5T_NO_CLASS</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga364545c053f925fec65880b235e37898" title="Returns a datatype class.">H5Tget_class()</a> returns the class of the datatype <code>type_id</code>. Valid class identifiers, as defined in <a class="el" href="_h5_tpublic_8h.html">H5Tpublic.h</a>, are: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a> {</div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a89ce244a6cbb3d0205291f41f08647a8">H5T_NO_CLASS</a> = -1, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aba1fc36abc23f073912e337d2291b037">H5T_INTEGER</a> = 0, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2e92f1a42a19de186a139ab8ff0745a9">H5T_FLOAT</a> = 1, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a8d3af61b1a73c5682f7f9b131754f6e3">H5T_TIME</a> = 2, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2de5d7919fe54466b7cf6a6c0b4265fa">H5T_STRING</a> = 3, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aae32f37ec15a835aa08d9277ad7ffaa2">H5T_BITFIELD</a> = 4, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2aaf11325a64ed5369e88d8d0d600b5cce">H5T_OPAQUE</a> = 5, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a7a401c61604dc846dbd3f9eb6fcb0fe6">H5T_COMPOUND</a> = 6, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5850e0b9353a5e7aeb615fb943d4e9cd">H5T_REFERENCE</a> = 7, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5ee305303f12787367ac271d8f28f2e6">H5T_ENUM</a> = 8, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2ad8ff83b6b7ca22575263561221193028">H5T_VLEN</a> = 9, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a547a4451911e912127f300ab15113854">H5T_ARRAY</a> = 10, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a900b6431883be49bde07daf9263ed117">H5T_NCLASSES</a> </div> -<div class="line">} <a class="code" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2">H5T_class_t</a>;</div> -</div><!-- fragment --> <dl class="section note"><dt>Note</dt><dd>The library returns <a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2de5d7919fe54466b7cf6a6c0b4265fa">H5T_STRING</a> for both fixed-length and variable-length strings.</dd> -<dd> -Unsupported datatype: The time datatype class, <a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a8d3af61b1a73c5682f7f9b131754f6e3">H5T_TIME</a>, is not supported. If <a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a8d3af61b1a73c5682f7f9b131754f6e3">H5T_TIME</a> is used, the resulting data will be readable and modifiable only on the originating computing platform; it will not be portable to other platforms. </dd></dl> - -</div> -</div> -<a id="ga6802c22c6e90216aa839a4a83909a54c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga6802c22c6e90216aa839a4a83909a54c">◆ </a></span>H5Tget_create_plist()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Tget_create_plist </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></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns a copy of a datatype's creation property list. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns a datatype creation property list identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga6802c22c6e90216aa839a4a83909a54c" title="Returns a copy of a datatype's creation property list.">H5Tget_create_plist()</a> returns a property list identifier for the datatype creation property list associated with the datatype specified by <code>type_id</code>.</p> -<p>The creation property list identifier should be released with <a class="el" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb" title="Terminates access to a property list.">H5Pclose()</a> to prevent memory leaks.</p> -<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> - -</div> -</div> -<a id="ga05b99133058637e8daa5d745381ddd3d"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga05b99133058637e8daa5d745381ddd3d">◆ </a></span>H5Tget_native_type()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Tget_native_type </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> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33d">H5T_direction_t</a> </td> - <td class="paramname"><em>direction</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns the native datatype identifier of a specified datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">direction</td><td>Direction of search</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns a native datatype identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga05b99133058637e8daa5d745381ddd3d" title="Returns the native datatype identifier of a specified datatype.">H5Tget_native_type()</a> returns the equivalent native datatype identifier for the datatype specified by <code>type_id</code>.</p> -<p><a class="el" href="group___h5_t.html#ga05b99133058637e8daa5d745381ddd3d" title="Returns the native datatype identifier of a specified datatype.">H5Tget_native_type()</a> is designed primarily to facilitate the use of the <a class="el" href="group___h5_d.html#ga8287d5a7be7b8e55ffeff68f7d26811c" title="Reads raw data from a dataset into a provided buffer.">H5Dread()</a> function, for which users otherwise must undertake a multi-step process to determine the native datatype of a dataset prior to reading it into memory. This function can be used for the following purposes:</p> -<ul> -<li>To determine the native datatype of an atomic datatype </li> -<li>To determine the base datatype of an array, enumerated, or variable-length datatype </li> -<li>To determine the native atomic datatypes of the individual components of a compound datatype</li> -</ul> -<p>For example, if <code>type_id</code> is a compound datatype, the returned datatype identifier will be for a similar compound datatype with each element converted to the corresponding native datatype; nested compound datatypes will be unwound. If <code>type_id</code> is an array, the returned datatype identifier will be for the native datatype of a single array element.</p> -<p><a class="el" href="group___h5_t.html#ga05b99133058637e8daa5d745381ddd3d" title="Returns the native datatype identifier of a specified datatype.">H5Tget_native_type()</a> selects the first matching native datatype from the following list:</p> -<ul> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga7439560bc4ef6d995a4e35b30262e660">H5T_NATIVE_CHAR</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#gae0625357fa121eca117f7fa9c4701810">H5T_NATIVE_SHORT</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga3cf93ffc6782be68070ef8e00f219ec2">H5T_NATIVE_INT</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga290b9655882754ee0ec9f31b42ac04f6">H5T_NATIVE_LONG</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#gafb9c5d393d693869d7d21f71753a532c">H5T_NATIVE_LLONG</a></li> -</ul> -<ul> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga39cadf50f1701a2af3afa86eba3c7cbd">H5T_NATIVE_UCHAR</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#gad0a240282e54647b83fe28ef65b40655">H5T_NATIVE_USHORT</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga904b507c7b8aa4838fbb7c6ce71a37c5">H5T_NATIVE_UINT</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#gacaea6c2c381167bacf67f6d6c43eb718">H5T_NATIVE_ULONG</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga91ed0d2ce3289ef3707449cf5babe928">H5T_NATIVE_ULLONG</a></li> -</ul> -<ul> -<li><a class="el" href="group___p_d_t_n_a_t.html#gae2523b63144b498f555fa4d04f59ee1c">H5T_NATIVE_FLOAT</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga087f3b793a299e416bd68678c2ef7c09">H5T_NATIVE_DOUBLE</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga6b68c680440c463ce03c5efbf8cdf1c0">H5T_NATIVE_LDOUBLE</a></li> -</ul> -<ul> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga2ed3827a2add0f6f2252c17e231b84b1">H5T_NATIVE_B8</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga81aba8febe34dc8ae2c9fa06aa4c4800">H5T_NATIVE_B16</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga87ec5cf19bdbf8203ca1e9a19bc59a9f">H5T_NATIVE_B32</a> </li> -<li><a class="el" href="group___p_d_t_n_a_t.html#ga4fe14f1ec3a8bd68112df6859e2db783">H5T_NATIVE_B64</a></li> -</ul> -<p>The direction parameter indicates the order in which the library searches for a native datatype match. Valid values for direction are as follows: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33d">H5T_direction_t</a> {</div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33da15b446e6a306e3824cf0003108d6b51c">H5T_DIR_DEFAULT</a> = 0, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33da0c49a07f752898162207bb2767b20cc6">H5T_DIR_ASCEND</a> = 1, </div> -<div class="line"> <a class="code" href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33da0336937de0b818d85ed905694144d8dc">H5T_DIR_DESCEND</a> = 2 </div> -<div class="line">} <a class="code" href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33d">H5T_direction_t</a>;</div> -<div class="ttc" id="a_h5_tpublic_8h_html_a891787104495ea80c677ab7042bfc33d"><div class="ttname"><a href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33d">H5T_direction_t</a></div><div class="ttdeci">H5T_direction_t</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:157</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a891787104495ea80c677ab7042bfc33da0336937de0b818d85ed905694144d8dc"><div class="ttname"><a href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33da0336937de0b818d85ed905694144d8dc">H5T_DIR_DESCEND</a></div><div class="ttdeci">@ H5T_DIR_DESCEND</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:160</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a891787104495ea80c677ab7042bfc33da0c49a07f752898162207bb2767b20cc6"><div class="ttname"><a href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33da0c49a07f752898162207bb2767b20cc6">H5T_DIR_ASCEND</a></div><div class="ttdeci">@ H5T_DIR_ASCEND</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:159</div></div> -<div class="ttc" id="a_h5_tpublic_8h_html_a891787104495ea80c677ab7042bfc33da15b446e6a306e3824cf0003108d6b51c"><div class="ttname"><a href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33da15b446e6a306e3824cf0003108d6b51c">H5T_DIR_DEFAULT</a></div><div class="ttdeci">@ H5T_DIR_DEFAULT</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:158</div></div> -</div><!-- fragment --><p> <a class="el" href="group___h5_t.html#ga05b99133058637e8daa5d745381ddd3d" title="Returns the native datatype identifier of a specified datatype.">H5Tget_native_type()</a> is designed primarily for use with integer, floating point, and bitfield datatypes. String, time, opaque, and reference datatypes are returned as a copy of dtype_id. See above for compound, array, enumerated, and variable-length datatypes.</p> -<p>The identifier returned by <a class="el" href="group___h5_t.html#ga05b99133058637e8daa5d745381ddd3d" title="Returns the native datatype identifier of a specified datatype.">H5Tget_native_type()</a> should eventually be closed by calling <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a> to release resources.</p> -<dl class="section note"><dt>Note</dt><dd>Please note that a datatype is actually an object identifier or handle returned from opening the datatype. It is not persistent, and its value can be different from one HDF5 session to the next.</dd> -<dd> -<a class="el" href="group___h5_t.html#gaa92250f289b557b63cba974defa20b0f" title="Determines whether two datatype identifiers refer to the same datatype.">H5Tequal()</a> can be used to compare datatypes.</dd> -<dd> -HDF5 High Level APIs that may also be of interest are: <a class="el" href="group___h5_l_t.html#ga6ec5b6204c4cddc5bd323918e51755dc" title="Creates a text description of an HDF5 datatype.">H5LTdtype_to_text()</a> creates a text description of a datatype. <a class="el" href="group___h5_l_t.html#ga107d1c8619493704ae501e55dd669efd" title="Creates an HDF5 datatype given a text description.">H5LTtext_to_dtype()</a> creates an HDF5 datatype given a text description.</dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl> - -</div> -</div> -<a id="ga1b971589cd7a86f3e84affdee455564e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga1b971589cd7a86f3e84affdee455564e">◆ </a></span>H5Tget_size()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">size_t H5Tget_size </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></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns the size of a datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns the size of the datatype in bytes if successful; otherwise, returns 0.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga1b971589cd7a86f3e84affdee455564e" title="Returns the size of a datatype.">H5Tget_size()</a> returns the size of a datatype in bytes. </p><ul> -<li>For atomic datatypes, array datatypes, compound datatypes, and other datatypes of a constant size, the returned value is the size of the actual datatype in bytes. </li> -<li>For variable-length string datatypes the returned value is the size of the pointer to the actual string, or <code>sizeof</code>(<code>char</code> <code>*</code>). This function does not return the size of actual variable-length string data. </li> -<li>For variable-length sequence datatypes (see <a class="el" href="group___v_l_e_n.html#ga6841355fa5b3c924876b121dedb8ed2f" title="Creates a new variable-length array datatype.">H5Tvlen_create()</a>), the returned value is the size of the <code><a class="el" href="structhvl__t.html">hvl_t</a></code> struct, or <code>sizeof</code>(<code><a class="el" href="structhvl__t.html">hvl_t</a></code>). The <code><a class="el" href="structhvl__t.html">hvl_t</a></code> struct contains a pointer to the actual data and a size value. This function does not return the size of actual variable-length sequence data.</li> -</ul> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_t.html#gae5f38bfd4a4c557496b3194b5180212c" title="Sets size for a datatype.">H5Tset_size()</a></dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> - -</div> -</div> -<a id="ga331e8f7b388a50af77294018db788de3"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga331e8f7b388a50af77294018db788de3">◆ </a></span>H5Tget_super()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Tget_super </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>type</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns the base datatype from which a datatype is derived. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Datatype identifier</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns a datatype identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga331e8f7b388a50af77294018db788de3" title="Returns the base datatype from which a datatype is derived.">H5Tget_super()</a> returns the base datatype from which the datatype <code>type_id</code> is derived. In the case of an enumeration type, the return value is an integer type.</p> -<p>The datatype identifier returned by this function must be released with <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a> when the identifier is no longer needed so that resource leaks will not develop. </p> - -</div> -</div> -<a id="ga523642dbf4c60a83127fff87664a965b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga523642dbf4c60a83127fff87664a965b">◆ </a></span>H5Tlock()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tlock </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></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Locks a datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier</td></tr> - </table> - </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___h5_t.html#ga523642dbf4c60a83127fff87664a965b" title="Locks a datatype.">H5Tlock()</a> locks the datatype specified by the dtype_id identifier, making it read-only and non-destructible. This is normally done by the library for predefined datatypes so the application does not inadvertently change or delete a predefined type. Once a datatype is locked it can never be unlocked. </p> - -</div> -</div> -<a id="ga9f76fa0dc34bc7b310e100e5bfed66fb"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga9f76fa0dc34bc7b310e100e5bfed66fb">◆ </a></span>H5Topen1()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Topen1 </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>loc_id</em>, </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> - </tr> - </table> -</div><div class="memdoc"> - -<p>Opens a named datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>A datatype name, defined within the specified file or group</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000085">Deprecated:</a></b></dt><dd>This function has been renamed from <a class="el" href="group___h5_t.html#ga1d14b407603fdcedfbed1f723784c209">H5Topen()</a> and is deprecated in favor of the macro <a class="el" href="group___h5_t.html#ga1d14b407603fdcedfbed1f723784c209">H5Topen</a> or the function <a class="el" href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2" title="Opens a committed (named) datatype.">H5Topen2()</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga9f76fa0dc34bc7b310e100e5bfed66fb" title="Opens a named datatype.">H5Topen1()</a> opens a named datatype at the location specified by <code>loc_id</code> and returns an identifier for the datatype. <code>loc_id</code> can be either a file or group identifier. The identifier should eventually be closed by calling <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a> to release resources.</p> -<dl class="section version"><dt>Version</dt><dd>1.8.0 Function <a class="el" href="group___h5_t.html#ga1d14b407603fdcedfbed1f723784c209">H5Topen()</a> renamed to <a class="el" href="group___h5_t.html#ga9f76fa0dc34bc7b310e100e5bfed66fb" title="Opens a named datatype.">H5Topen1()</a> and deprecated in this release.</dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> - -</div> -</div> -<a id="ga7e65e77634f1fb4ba38cbcdab9a59bc2"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga7e65e77634f1fb4ba38cbcdab9a59bc2">◆ </a></span>H5Topen2()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Topen2 </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>loc_id</em>, </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 class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>tapl_id</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Opens a committed (named) datatype. </p> -<hr /> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the datatype to open </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">tapl_id</td><td>Datatype access property list identifier</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns a datatype identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> -<p><a class="el" href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2" title="Opens a committed (named) datatype.">H5Topen2()</a> opens a committed datatype at the location specified by <code>loc_id</code> and returns an identifier for the datatype. <code>loc_id</code> is either a file or group identifier. The identifier should eventually be closed by calling <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a> to release resources.</p> -<p>The committed datatype is opened with the datatype access property list tapl_id.</p> -<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> - -</div> -</div> -<a id="gad92e4af6b8ac52712fb4238281f921e9"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gad92e4af6b8ac52712fb4238281f921e9">◆ </a></span>H5Topen_async()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Topen_async </td> - <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>loc_id</em>, </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 class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>tapl_id</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>es_id</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Asynchronous version of <a class="el" href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2" title="Opens a committed (named) datatype.">H5Topen2()</a>. </p> - -</div> -</div> -<a id="ga5bc56f6b85e114829dc12d6b18d66f4d"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga5bc56f6b85e114829dc12d6b18d66f4d">◆ </a></span>H5Trefresh()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Trefresh </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></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Refreshes all buffers associated with a committed datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier</td></tr> - </table> - </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___h5_t.html#ga5bc56f6b85e114829dc12d6b18d66f4d" title="Refreshes all buffers associated with a committed datatype.">H5Trefresh()</a> causes all buffers associated with a committed datatype to be cleared and immediately re-loaded with updated contents from disk.</p> -<p>This function essentially closes the datatype, evicts all metadata associated with it from the cache, and then reopens the datatype. The reopened datatype is automatically re-registered with the same identifier.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> - -</div> -</div> -<a id="gae5f38bfd4a4c557496b3194b5180212c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gae5f38bfd4a4c557496b3194b5180212c">◆ </a></span>H5Tset_size()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Tset_size </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> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">size_t </td> - <td class="paramname"><em>size</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Sets size for a datatype. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>New datatype size in bytes or <a class="el" href="_h5_tpublic_8h.html#a5185e14efde13b48249fe391324331bc">H5T_VARIABLE</a></td></tr> - </table> - </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___h5_t.html#gae5f38bfd4a4c557496b3194b5180212c" title="Sets size for a datatype.">H5Tset_size()</a> sets the total size, <code>size</code>, in bytes, for a datatype.</p> -<p><code>size</code> must have a positive value unless it is passed in as <a class="el" href="_h5_tpublic_8h.html#a5185e14efde13b48249fe391324331bc">H5T_VARIABLE</a> and the datatype is a string datatype.</p> -<ul> -<li>Numeric datatypes: If the datatype is atomic and the size is decreased so that significant bits of the datatype extend beyond the edge of the new size, then the offset property of the datatype is decreased toward zero. If the offset becomes zero and the significant bits of the datatype still hang over the edge of the new size, then the number of significant bits is decreased.</li> -</ul> -<ul> -<li>String or character datatypes: The size set for a string datatype should include space for the null-terminator character, otherwise it will not be stored on (or retrieved from) the disk. Adjusting the size of a string automatically sets the precision to <code>8*size</code>.</li> -</ul> -<ul> -<li>Variable-length string datatypes: If <code>dtype_id</code> is a variable-length string, size must normally be set to <a class="el" href="_h5_tpublic_8h.html#a5185e14efde13b48249fe391324331bc">H5T_VARIABLE</a>. See <em>Creating variable-length string datatypes</em>.</li> -</ul> -<ul> -<li>Compound datatypes: This function may be used to increase or decrease the size of a compound datatype, but the function will fail if the new size is too small to accommodate all member fields.</li> -</ul> -<ul> -<li>Ineligible datatypes: This function cannot be used with enumerated datatypes (<a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5ee305303f12787367ac271d8f28f2e6">H5T_ENUM</a>), array datatypes (<a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a547a4451911e912127f300ab15113854">H5T_ARRAY</a>), variable-length array datatypes (<a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2ad8ff83b6b7ca22575263561221193028">H5T_VLEN</a>), or reference datatypes (<a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5850e0b9353a5e7aeb615fb943d4e9cd">H5T_REFERENCE</a>).</li> -</ul> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_t.html#ga1b971589cd7a86f3e84affdee455564e" title="Returns the size of a datatype.">H5Tget_size()</a></dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> - -</div> -</div> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <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> - </ul> -</div> -</body> -</html> |