1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
<!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: HDF5 Reference Manual</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.b166368</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('_r_m.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="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">HDF5 Reference Manual </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The functions provided by the HDF5 API are grouped into the following <em>modules</em>:</p>
<table class="doxtable">
<tr>
<th>Modules </th></tr>
<tr valign="top">
<td><table class="doxtable">
<caption>Core Reference Manual Modules</caption>
<tr>
<th>Module</th><th colspan="4">Language</th><th>Description </th></tr>
<tr>
<th>Attributes (H5A)</th><td><a class="el" href="group___h5_a.html">C</a></td><td><a class="el" href="class_h5_1_1_attribute.html">C++</a></td><td><a class="el" href="group___f_h5_a.html">Fortran</a></td><td><a class="el" href="group___j_h5_a.html">Java</a></td><td>HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. </td></tr>
<tr>
<th>Datasets (H5D)</th><td><a class="el" href="group___h5_d.html">C</a></td><td><a class="el" href="class_h5_1_1_data_set.html">C++</a></td><td><a class="el" href="group___f_h5_d.html">Fortran</a></td><td><a class="el" href="group___j_h5_d.html">Java</a></td><td>Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties. </td></tr>
<tr>
<th>Dataspaces (H5S)</th><td><a class="el" href="group___h5_s.html">C</a></td><td><a class="el" href="class_h5_1_1_data_space.html">C++</a></td><td><a class="el" href="group___f_h5_s.html">Fortran</a></td><td><a class="el" href="group___j_h5_s.html">Java</a></td><td>HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files. </td></tr>
<tr>
<th>Datatypes (H5T)</th><td><a class="el" href="group___h5_t.html">C</a></td><td><a class="el" href="class_h5_1_1_data_type.html">C++</a></td><td><a class="el" href="group___f_h5_t.html">Fortran</a></td><td><a class="el" href="group___j_h5_t.html">Java</a></td><td>HDF5 datatypes describe the element type of HDF5 datasets and attributes. </td></tr>
<tr>
<th>Error Handling (H5E)</th><td><a class="el" href="group___h5_e.html">C</a></td><td><a class="el" href="class_h5_1_1_exception.html">C++</a></td><td><a class="el" href="group___f_h5_e.html">Fortran</a></td><td><a class="el" href="group___j_h5_e.html">Java</a></td><td>HDF5 library error reporting. </td></tr>
<tr>
<th>Event Set (H5ES)</th><td><a class="el" href="group___h5_e_s.html">C</a></td><td>"C++"</td><td>"Fortran"</td><td>"Java"</td><td>HDF5 event set life cycle used with HDF5 VOL connectors that enable the asynchronous feature in HDF5. </td></tr>
<tr>
<th>Files (H5F)</th><td><a class="el" href="group___h5_f.html">C</a></td><td><a class="el" href="class_h5_1_1_h5_file.html">C++</a></td><td><a class="el" href="group___f_h5_f.html">Fortran</a></td><td><a class="el" href="group___j_h5_f.html">Java</a></td><td>Manage HDF5 files. </td></tr>
<tr>
<th>Filters (H5Z)</th><td><a class="el" href="group___h5_z.html">C</a></td><td>"C++"</td><td><a class="el" href="group___f_h5_z.html">Fortran</a></td><td><a class="el" href="group___j_h5_z.html">Java</a></td><td>Manage HDF5 user-defined filters </td></tr>
<tr>
<th>Groups (H5G)</th><td><a class="el" href="group___h5_g.html">C</a></td><td><a class="el" href="class_h5_1_1_group.html">C++</a></td><td><a class="el" href="group___f_h5_g.html">Fortran</a></td><td><a class="el" href="group___j_h5_g.html">Java</a></td><td>Manage HDF5 groups. </td></tr>
<tr>
<th>Identifiers (H5I)</th><td><a class="el" href="group___h5_i.html">C</a></td><td><a class="el" href="class_h5_1_1_id_component.html">C++</a></td><td><a class="el" href="group___f_h5_i.html">Fortran</a></td><td><a class="el" href="group___j_h5_i.html">Java</a></td><td>Manage identifiers defined by the HDF5 library. </td></tr>
<tr>
<th>Library General (H5)</th><td><a class="el" href="group___h5.html">C</a></td><td><a class="el" href="class_h5_1_1_h5_library.html">C++</a></td><td><a class="el" href="group___f_h5.html">Fortran</a></td><td><a class="el" href="group___j_h5.html">Java</a></td><td>Manage the life cycle of HDF5 library instances. </td></tr>
<tr>
<th>Links (H5L)</th><td><a class="el" href="group___h5_l.html">C</a></td><td>"C++"</td><td><a class="el" href="group___f_h5_l.html">Fortran</a></td><td><a class="el" href="group___j_h5_l.html">Java</a></td><td>Manage HDF5 links and link types. </td></tr>
<tr>
<th>Objects (H5O)</th><td><a class="el" href="group___h5_o.html">C</a></td><td>"C++"</td><td><a class="el" href="group___f_h5_o.html">Fortran</a></td><td><a class="el" href="group___j_h5_o.html">Java</a></td><td>Manage HDF5 objects (groups, datasets, datatype objects). </td></tr>
<tr>
<th>Property Lists (H5P)</th><td><a class="el" href="group___h5_p.html">C</a></td><td><a class="el" href="class_h5_1_1_prop_list.html">C++</a></td><td><a class="el" href="group___f_h5_p.html">Fortran</a></td><td><a class="el" href="group___j_h5_p.html">Java</a></td><td>HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions. </td></tr>
<tr>
<th>Dynamically-loaded Plugins (H5PL)</th><td><a class="el" href="group___h5_p_l.html">C</a></td><td>"C++"</td><td>"Fortran"</td><td><a class="el" href="group___j_h5_p_l.html">Java</a></td><td>Manage the loading behavior of HDF5 plugins. </td></tr>
<tr>
<th>References (H5R)</th><td><a class="el" href="group___h5_r.html">C</a></td><td>"C++"</td><td><a class="el" href="group___f_h5_r.html">Fortran</a></td><td><a class="el" href="group___j_h5_r.html">Java</a></td><td>Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions). </td></tr>
<tr>
<th>VOL Connector (H5VL)</th><td><a class="el" href="group___h5_v_l.html">C</a></td><td>"C++"</td><td><a class="el" href="group___f_h5_v_l.html">Fortran</a></td><td><a class="el" href="group___j_h5_v_l.html">Java</a></td><td>Manage HDF5 VOL connector plugins. </td></tr>
</table>
<table class="doxtable">
<caption>High-level Reference Manual Modules</caption>
<tr>
<th>Module</th><th colspan="4">Language</th><th>Description </th></tr>
<tr>
<th>HDF5 Lite APIs (H5LT,H5LD)</th><td><a class="el" href="group___h5_l_t.html">C</a></td><td>"C++"</td><td><a class="el" href="group___f_h5_l_t.html">Fortran</a></td><td>"Java"</td><td>Functions to simplify creating and manipulating datasets, attributes and other features. </td></tr>
<tr>
<th>HDF5 Images API (H5IM)</th><td><a class="el" href="group___h5_i_m.html">C</a></td><td>"C++"</td><td><a class="el" href="group___f_h5_i_m.html">Fortran</a></td><td>"Java"</td><td>Creating and manipulating HDF5 datasets intended to be interpreted as images. </td></tr>
<tr>
<th>HDF5 Table APIs (H5TB)</th><td><a class="el" href="group___h5_t_b.html">C</a></td><td>"C++"</td><td><a class="el" href="group___f_h5_t_b.html">Fortran</a></td><td>"Java"</td><td>Creating and manipulating HDF5 datasets intended to be interpreted as tables. </td></tr>
<tr>
<th>HDF5 Packet Table APIs (H5PT)</th><td><a class="el" href="group___h5_p_t.html">C</a></td><td>"C++"</td><td>"Fortran"</td><td>"Java"</td><td>Creating and manipulating HDF5 datasets to support append- and read-only operations on table data. </td></tr>
<tr>
<th>HDF5 Dimension Scales APIs (H5DS)</th><td><a class="el" href="group___h5_d_s.html">C</a></td><td>"C++"</td><td><a class="el" href="group___f_h5_d_s.html">Fortran</a></td><td>"Java"</td><td>Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset. </td></tr>
<tr>
<th>HDF5 Optimizations APIs (H5DO)</th><td><a class="el" href="group___h5_d_o.html">C</a></td><td>"C++"</td><td>"Fortran"</td><td>"Java"</td><td>Bypassing default HDF5 behavior in order to optimize for specific use cases. </td></tr>
<tr>
<th>Extensions (H5LR, H5LT)</th><td><a class="el" href="group___h5_l_r.html">C</a></td><td>"C++"</td><td>"Fortran"</td><td>"Java"</td><td></td></tr>
</table>
</td></tr>
<tr>
<td><table class="doxtable">
<caption>Additional Java Reference Manual Modules</caption>
<tr>
<td><a class="el" href="_h_d_f5_c_o_n_s_t.html">Constants and Enumerated Types</a></td><td>This class contains C constants and enumerated types of HDF5 library. </td></tr>
<tr>
<td><a class="el" href="_h_d_f_n_a_t_i_v_e.html">Native Arrays of Numbers</a></td><td>This class encapsulates native methods to deal with arrays of numbers, converting from numbers to bytes and bytes to numbers. </td></tr>
<tr>
<td><a class="el" href="_h_d_f_a_r_r_a_y.html">Java Array Conversion</a></td><td>This is a class for handling multidimensional arrays for HDF. </td></tr>
<tr>
<td><a class="el" href="_e_r_r_o_r_s.html">Errors and Exceptions</a></td><td>The class HDF5Exception returns errors from the Java HDF5 Interface. </td></tr>
</table>
</td></tr>
<tr>
<td><a class="el" href="predefined_datatypes_tables.html">HDF5 Predefined Datatypes</a><br />
<a href="./deprecated.html">Deprecated functions</a><br />
Functions with <a class="el" href="group___a_s_y_n_c.html">Asynchronous Functions</a><br />
<a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </td></tr>
</table>
<p>Follow these simple rules and stay out of trouble:</p>
<ul>
<li><b>Handle discipline:</b> The HDF5 API is rife with handles or identifiers, which you typically obtain by creating new HDF5 items, copying items, or retrieving facets of items. Consequently, <b>and most importantly</b>, you are responsible for releasing the underlying resources via the matching <code>H5*close()</code> call, or deal with the consequences of resource leakage. </li>
<li><b>Closed means closed:</b> Do not pass identifiers that were previously <code>H5*close()</code>-d to other API functions! It will generate an error. </li>
<li><b>Dynamic memory allocation:</b> The API contains a few functions in which the HDF5 library dynamically allocates memory on the caller's behalf. The caller owns this memory and eventually must free it by calling <a class="el" href="group___h5.html#ga71872bf6445cba956da86d4762b662cf" title="Frees memory allocated by the HDF5 library.">H5free_memory()</a> and not language-explicit memory functions. </li>
<li><b>Don't modify while iterating:</b> Do not modify the underlying collection when an iteration is in progress! </li>
<li><b>Use of locations:</b> Certain API functions, typically called <code>H5***_by_name</code> use a combination of identifiers and path names to refer to HDF5 objects. If the identifier fully specifies the object in question, pass <code>'.'</code> (a dot) for the name!</li>
</ul>
<dl class="section attention"><dt>Attention</dt><dd><b>C++ Developers using HDF5 C-API functions beware:</b><br />
Several functions in this C-API take function pointers or callbacks as arguments. Examples include <a class="el" href="group___l_a_p_l.html#ga8850042eed51777866d7bd0d050cfdc2" title="Sets the external link traversal callback function in a link access property list.">H5Pset_elink_cb()</a>, <a class="el" href="group___d_x_p_l.html#ga10a80b29444d933da1aa2003f46cf003" title="Sets user-defined datatype conversion callback function.">H5Pset_type_conv_cb()</a>, <a class="el" href="group___c_o_n_v.html#ga9442478475a03357ee47fa035df0228a" title="Converts data from one specified datatype to another.">H5Tconvert()</a>, and <a class="el" href="group___h5_e.html#ga4ecc0f6a1ea5bb821373a5a7b8070655" title="Walks the specified error stack, calling the specified function.">H5Ewalk2()</a>. Application code must ensure that those callback functions return normally such to allow the HDF5 to manage its resources and maintain a consistent state. For instance, those functions must not use the C <code>setjmp</code> / <code>longjmp</code> mechanism to leave those callback functions. Within the context of C++, any exceptions thrown within the callback function must be caught, such as with a <code>catch(…)</code> statement. Any exception state can be placed within the provided user data function call arguments, and may be thrown again once the calling function has returned. Exceptions raised and not handled inside the callback are not supported as it might leave the HDF5 library in an inconsistent state. Similarly, using C++20 coroutines cannot be used as callbacks, since they do not support plain return statements. If a callback function yields execution to another C++20 coroutine calling HDF5 functions as well, this may lead to undefined behavior.</dd></dl>
<dl class="section user"><dt>Don't like what you see? - You can help to improve this Reference Manual</dt><dd>Complete the survey linked near the top of this page!<br />
We treat documentation like code: Fork the <a href="https://github.com/HDFGroup/hdf5">HDF5 repo</a>, make changes, and create a <a href="https://github.com/HDFGroup/hdf5/pulls">pull request</a> !<br />
See the <a class="el" href="_r_m_t.html">Reference Manual (RM) Page Template</a> for general guidance. </dd></dl>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</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>
|
