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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: HDF5 User Guide</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.2908dd1</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('_u_g.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">HDF5 User Guide</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><center> HDF5 Release 1.14</center><center><div class="image">
<img src="HDFG-logo.png" alt=""/>
<div class="caption">
The HDF Group</div></div>
</center><center></center><p><a class="el" href="_h5_d_m__u_g.html#sec_data_model">The HDF5 Data Model and File Structure</a> </p><ul>
<li><a class="el" href="_h5_d_m__u_g.html#subsec_data_model_intro">Introduction</a> </li>
<li><a class="el" href="_h5_d_m__u_g.html#subsec_data_model_abstract">The Abstract Data Model</a> <ul>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_file">File</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_group">Group</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_dataset">Dataset</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_space">Dataspace</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_type">Datatype</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_attr">Attribute</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_plist">Property List</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_link">Link</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d_m__u_g.html#subsec_data_model_storage">The HDF5 Storage Model</a> <ul>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_storage_spec">The Abstract Storage Model: the HDF5 Format Specification</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_storage_imple">Concrete Storage Model</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d_m__u_g.html#subsec_data_model_structure">The Structure of an HDF5 File</a> <ul>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_structure_file">Overall File Structure</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_structure_path">HDF5 Path Names and Navigation</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_structure_example">Examples of HDF5 File Structures</a> </li>
</ul>
</li>
</ul>
<p><a class="el" href="_h5__u_g.html#sec_program">The HDF5 Library and Programming Model</a> </p><ul>
<li><a class="el" href="_h5__u_g.html#subsec_program_intro">Introduction</a> </li>
<li><a class="el" href="_h5__u_g.html#subsec_program_model">The HDF5 Programming Model</a> <ul>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_create">Creating an HDF5 File</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_dset">Creating and Initializing a Dataset</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_close">Closing an Object</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_data">Writing or Reading a Dataset to or from a File</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_partial">Reading and Writing a Portion of a Dataset</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_info">Getting Information about a Dataset</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_compound">Creating and Defining Compound Datatypes</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_extend">Creating and Writing Extendable Datasets</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_group">Creating and Working with Groups</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_attr">Working with Attributes</a> </li>
</ul>
</li>
<li><a class="el" href="_h5__u_g.html#subsec_program_transfer_pipeline">The Data Transfer Pipeline</a></li>
</ul>
<p><a class="el" href="_h5_f__u_g.html#sec_file">The HDF5 File</a> </p><ul>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_intro">Introduction</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_access_modes">File Access Modes</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_creation_access">File Creation and File Access Properties</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_drivers">Low-level File Drivers</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_program_model">Programming Model for Files</a> <ul>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_program_model_create">Creating a New File</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_program_model_open">Opening an Existing File</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_program_model_close">Closing a File</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_h5dump">Using h5dump to View a File</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_summary">File Function Summaries</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_create">Creating or Opening an HDF5 File</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_closes">Closing an HDF5 File</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_property_lists">File Property Lists</a> <ul>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_property_lists_create">Creating a Property List</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_property_lists_props">File Creation Properties</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_property_lists_access">File Access Properties</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_alternate_drivers">Alternate File Storage Layouts and Low-level File Drivers</a> <ul>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_id">Identifying the Previously‐used File Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_sec2">The POSIX (aka SEC2) Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_direct">The Direct Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_log">The Log Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_win">The Windows Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_stdio">The STDIO Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_mem">The Memory (aka Core) Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_family">The Family Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_multi">The Multi Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_split">The Split Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_par">The Parallel Driver</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_examples">Code Examples for Opening and Closing Files</a> <ul>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_examples_trunc">Example Using the H5F_ACC_TRUNC Flag</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_examples_props">Example with the File Creation Property List</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_examples_access">Example with the File Access Property List</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_multiple">Working with Multiple HDF5 Files</a></li>
</ul>
<p><a class="el" href="_h5_g__u_g.html#sec_group">HDF5 Groups</a> </p><ul>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_intro">Introduction</a> </li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_descr">Description of the Group Object</a> <ul>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_descr_object">The Group Object</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_descr_model">The Hierarchy of Data Objects</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_descr_path">HDF5 Path Names</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_descr_impl">Group Implementations in HDF5</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_h5dump">Using h5dump</a> </li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_function">Group Function Summaries</a> </li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_program">Programming Model for Groups</a> <ul>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_create">Creating a Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_open">Opening a Group and Accessing an Object in that Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_dataset">Creating a Dataset in a Specific Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_close">Closing a Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_links">Creating Links</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_info">Discovering Information about Objects</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_objs">Discovering Objects in a Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_all">Discovering All of the Objects in the File</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_examples">Examples of File Structures</a></li>
</ul>
<p><a class="el" href="_h5_d__u_g.html#sec_dataset">HDF5 Datasets</a> </p><ul>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_intro">Introduction</a> </li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_function">Dataset Function Summaries</a> </li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_program">Programming Model for Datasets</a> <ul>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_program_general">General Model</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_program_create">Create Dataset</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_program_transfer">Data Transfer Operations on a Dataset</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_program_read">Retrieve the Properties of a Dataset</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_transfer">Data Transfer</a> <ul>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_pipe">The Data Pipeline</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_filter">Data Pipeline Filters</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_drive">File Drivers</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_props">Data Transfer Properties to Manage the Pipeline</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_store">Storage Strategies</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_partial">Partial I/O Sub‐setting and Hyperslabs</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_allocation">Allocation of Space in the File</a> <ul>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_allocation_store">Storage Allocation in the File: Early, Incremental, Late</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_allocation_delete">Deleting a Dataset from a File and Reclaiming Space</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_allocation_release">Releasing Memory Resources</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_allocation_ext">External Storage Properties</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_filters">Using HDF5 Filters</a> <ul>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_filters_nbit">Using the N‐bit Filter</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_filters_scale">Using the Scale‐offset Filter</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_filters_szip">Using the Szip Filter</a> </li>
</ul>
</li>
</ul>
<p><a class="el" href="_h5_t__u_g.html#sec_datatype">HDF5 Datatypes</a> </p><ul>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_intro">Introduction and Definitions</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_model">Datatype Model</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_model_class">Datatype Classes and Properties</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_model_predefine">Predefined Datatypes</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_usage">How Datatypes are Used</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_object">The Datatype Object and the HDF5 Datatype API</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_create">Dataset Creation</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_transfer">Data Transfer (Read and Write)</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_discover">Discovery of Data Format</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_user">Creating and Using User‐defined Datatypes</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_function">Datatype Function Summaries</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_program">Programming Model for Datatypes</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_program_discover">Discovery of Datatype Properties</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_program_define">Definition of Datatypes</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_other">Other Non-numeric Datatypes</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_strings">Strings</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_refs">Reference</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_enum">ENUM</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_opaque">Opaque</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_bitfield">Bitfield</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_fill">Fill Values</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_complex">Complex Combinations of Datatypes</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_complex_create">Creating a Complicated Compound Datatype</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_complex_analyze">Analyzing and Navigating a Compound Datatype</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_life">Life Cycle of the Datatype Object</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_transfer">Data Transfer: Datatype Conversion and Selection</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_text">Text Descriptions of Datatypes: Conversion to and from</a></li>
</ul>
<p><a class="el" href="_h5_s__u_g.html#sec_dataspace">HDF5 Dataspaces and Partial I/O</a> </p><ul>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_intro">Introduction</a> </li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_function">Dataspace Function Summaries</a> </li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_program">Definition of Dataspace Objects and the Dataspace Programming Model</a> <ul>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_program_object">Dataspace Objects</a> </li>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_program_model">Dataspace Programming Model</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_transfer">Dataspaces and Data Transfer</a> <ul>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_transfer_select">Data Selection</a> </li>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_transfer_model">Programming Model</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_select">Dataspace Selection Operations and Data Transfer</a> </li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_refer">References to Dataset Regions</a> <ul>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_refer_use">Example Uses for Region References</a> </li>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_refer_create">Creating References to Regions</a> </li>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_refer_read">Reading References to Regions</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_sample">Sample Programs</a></li>
</ul>
<p><a class="el" href="_h5_a__u_g.html#sec_attribute">HDF5 Attributes</a> </p><ul>
<li><a class="el" href="_h5_a__u_g.html#subsec_attribute_intro">Introduction</a> </li>
<li><a class="el" href="_h5_a__u_g.html#subsec_attribute_program">Programming Model for Attributes</a> <ul>
<li>
To Open and Read or Write an Existing Attribute </li>
</ul>
</li>
<li><a class="el" href="_h5_a__u_g.html#subsec_error_H5A">Attribute Function Summaries</a> </li>
<li><a class="el" href="_h5_a__u_g.html#subsec_attribute_work">Working with Attributes</a> <ul>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_struct">The Structure of an Attribute</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_create">Creating, Writing, and Reading Attributes</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_access">Accessing Attributes by Name or Index</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_info">Obtaining Information Regarding an Object's Attributes</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_iterate">Iterating across an Object's Attributes</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_delete">Deleting an Attribute</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_close">Closing an Attribute</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_a__u_g.html#subsec_attribute_special">Special Issues</a></li>
</ul>
<p><a class="el" href="_h5_e__u_g.html#sec_error">HDF5 Error Handling</a> </p><ul>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_intro">Introduction</a> </li>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_program">Programming Model for Error Handling</a> </li>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_H5E">Error Handling Function Summaries</a> </li>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_ops">Basic Error Handling Operations</a> <ul>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_stack">Error Stack and Error Message</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_print">Print and Clear an Error Stack</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_mute">Mute Error Stack</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_custom_print">Customized Printing of an Error Stack</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_walk">Walk through the Error Stack</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_travers">Traverse an Error Stack with a Callback Function</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_adv">Advanced Error Handling Operations</a> <ul>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_adv_more">More Error API Functions</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_adv_app">Pushing an Application Error Message onto Error Stack</a> </li>
</ul>
</li>
</ul>
<p><a class="el" href="_h5_p__u_g.html#sec_plist">Properties and Property Lists in HDF5</a> </p><ul>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_intro">Introduction</a> </li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_class">Property List Classes, Property Lists, and Properties</a> <ul>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_class">Property List Classes</a> </li>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_lists">Property Lists</a> </li>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_props">Properties</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_program">Programming Model for Properties and Property Lists</a> <ul>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_default">Using Default Property Lists</a> </li>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_basic">Basic Steps of the Programming Model</a> </li>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_additional">Additional Property List Operations</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_generic">Generic Properties Interface and User-defined Properties</a> </li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_H5P">Property List Function Summaries</a> </li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_resources">Additional Property List Resources</a> </li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_notes">Notes</a></li>
</ul>
<p><a class="el" href="_h5_v_l__u_g.html#sec_vol">The HDF5 Virtual Object Layer (VOL)</a> </p><ul>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_intro">Introduction</a> </li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_abstract_layer">The VOL Abstraction Layer</a> </li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_quickstart">Quickstart</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_read">Read The Documentation For The New VOL Connector</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_use">Use A VOL-Enabled HDF5 Library</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_set">Determine How You Will Set The VOL Connector</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_update">If Needed: Update Your Code To Load And Use A VOL Connector</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_plugin">If Using A Plugin: Make Sure The VOL Connector Is In The Search</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_opt">Optional: Set The VOL Connector Via The Environment Variable</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_connect">VOL Connectors</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_register">Registration</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_version">Connector Versioning</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_reg_calls">Connector-Specific Registration Calls</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_set_vol">H5Pset_vol()</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_search">VOL Connector Search Path</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_param">Parameter Strings</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_env">Environment Variable</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_adapt">Adapting HDF5 Software to Use the VOL</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_adapt_token">haddr_t → H5O_token_t</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_adapt_api">Specific API Call Substitutions</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_adapt_native">Protect Native-Only API Calls</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_lang">Language Wrappers</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_lang_c">C++</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_lang_fort">Fortran</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_lang_java">Java/JNI</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_cl">Using VOL Connectors With The HDF5 Command-Line Tools</a> </li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_compat">Compatibility</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_compat_native">List of HDF5 Native VOL API Calls</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_compat_indep">List of HDF5 VOL-Independent API Calls</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_compat_opt">List of Native VOL Optional Operation Values By Subclass</a> </li>
</ul>
</li>
</ul>
<p><a class="el" href="_h5_e_s__u_g.html#sec_async">The HDF5 Event Set Interface</a> </p><ul>
<li><a class="el" href="_h5_e_s__u_g.html#subsec_async_intro">Introduction</a></li>
</ul>
<p><a class="el" href="_h5_m__u_g.html#sec_map">The HDF5 Map Object</a></p>
<p><a class="el" href="_a_r__u_g.html#sec_addition">Additional Resources</a> </p>
</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.10.0 </li>
</ul>
</div>
</body>
</html>
|
