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
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
|
<!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: Extensions</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.112f445</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('group___h5_l_r.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Extensions</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><em>Working with region references, hyperslab selections, and bit-fields (H5LR, H5LT)</em></p>
<p>The following reference manual entries describe high-level HDF5 C and Fortran APIs for working with region references, hyperslab selections, and bit-fields. These functions were created as part of a project supporting NPP/NPOESS Data Production and Exploitation ( <a href="https://support.hdfgroup.org/projects/jpss/documentation">project</a>, <a href="https://gamma.hdfgroup.org/ftp/pub/outgoing/NPOESS/source">software </a>). While they were written to facilitate access to NPP, NPOESS, and JPSS data in the HDF5 format, these functions may be useful to anyone working with region references, hyperslab selections, or bit-fields.</p>
<p>Note that these functions are not part of the standard HDF5 distribution; the <a href="https://gamma.hdfgroup.org/ftp/pub/outgoing/NPOESS/source">software </a> must be separately downloaded and installed.</p>
<p>A comprehensive guide to this library, <a href="https://support.hdfgroup.org/projects/jpss/documentation/HL/UG/NPOESS_HL-UG.pdf"><em>User Guide to the HDF5 High-level Library for Handling Region References and Hyperslab Selections</em></a> is available at <a href="https://support.hdfgroup.org/projects/jpss/documentation/HL/UG/NPOESS_HL-UG.pdf">https://support.hdfgroup.org/projects/jpss/documentation/HL/UG/NPOESS_HL-UG.pdf</a>.</p>
<ul>
<li><a class="el" href="#ga889b19b609e4e44565467cb84c6eeb0d">H5LRcopy_reference</a> <br />
Copies data from the specified dataset to a new location and creates a reference to it.</li>
<li><a class="el" href="#ga3056840a05520e3a5e1b77f8cdd373c4">H5LRcopy_region</a> <br />
Copies data from a referenced region to a region in a destination dataset.</li>
<li><a class="el" href="#ga75787f84657d69421c6a8be57a9f070c">H5LRcreate_ref_to_all</a> <br />
Creates a dataset with the region references to the data in all datasets located under a specified group in a file or creates a dataset with object references to all objects (groups or datasets) located under a specified group in a file.</li>
<li><a class="el" href="#gacef1564aa36bdfceac13b7b2bdd8e2d8">H5LRcreate_region_references</a> <br />
Creates an array of region references using an array of paths to datasets and an array of corresponding hyperslab descriptions.</li>
<li><a class="el" href="#gabb053f246fd0cfcb588bafe98278b9b8">H5LRget_region_info</a> <br />
Retrieves information about the data a region reference points to.</li>
<li><a class="el" href="#gabbf9f8ea4d13d44d45efae5e143a157a">H5LRmake_dataset</a> <br />
Creates and writes a dataset containing a list of region references.</li>
<li><a class="el" href="#ga0cab2622e4ffba04c363d37b98b0a83b">H5LRread_region</a> <br />
Retrieves raw data pointed to by a region reference to an application buffer.</li>
<li><a class="el" href="#ga73fb3ab3e9b756a818e711cd335c819d">H5LTcopy_region</a> <br />
Copies data from a specified region in a source dataset to a specified region in a destination dataset.</li>
<li><a class="el" href="#ga1eec1ca149e662c4937e4ab10c30e0f6">H5LTread_bitfield_value</a> <br />
Retrieves the values of quality flags for each element to the application provided buffer.</li>
<li><a class="el" href="#ga291c97f18425bb1136f1eab304fb0722">H5LTread_region</a> <br />
Reads selected data to an application buffer. </li>
</ul>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabbf9f8ea4d13d44d45efae5e143a157a" id="r_gabbf9f8ea4d13d44d45efae5e143a157a"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabbf9f8ea4d13d44d45efae5e143a157a">H5LRmake_dataset</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *path, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, const size_t buf_size, const <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> *loc_id_ref, const <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *buf)</td></tr>
<tr class="memdesc:gabbf9f8ea4d13d44d45efae5e143a157a"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes a dataset containing a list of region references. <br /></td></tr>
<tr class="separator:gabbf9f8ea4d13d44d45efae5e143a157a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacef1564aa36bdfceac13b7b2bdd8e2d8" id="r_gacef1564aa36bdfceac13b7b2bdd8e2d8"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacef1564aa36bdfceac13b7b2bdd8e2d8">H5LRcreate_region_references</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, size_t num_elem, const char **path, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *block_coord, <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *buf)</td></tr>
<tr class="memdesc:gacef1564aa36bdfceac13b7b2bdd8e2d8"><td class="mdescLeft"> </td><td class="mdescRight">Creates an array of region references using an array of paths to datasets and an array of corresponding hyperslab descriptions. <br /></td></tr>
<tr class="separator:gacef1564aa36bdfceac13b7b2bdd8e2d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga889b19b609e4e44565467cb84c6eeb0d" id="r_ga889b19b609e4e44565467cb84c6eeb0d"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga889b19b609e4e44565467cb84c6eeb0d">H5LRcopy_reference</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *ref, const char *file, const char *path, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *block_coord, <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *ref_new)</td></tr>
<tr class="memdesc:ga889b19b609e4e44565467cb84c6eeb0d"><td class="mdescLeft"> </td><td class="mdescRight">Copies data from the specified dataset to a new location and creates a reference to it. <br /></td></tr>
<tr class="separator:ga889b19b609e4e44565467cb84c6eeb0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3056840a05520e3a5e1b77f8cdd373c4" id="r_ga3056840a05520e3a5e1b77f8cdd373c4"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3056840a05520e3a5e1b77f8cdd373c4">H5LRcopy_region</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *ref, const char *file, const char *path, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *block_coord)</td></tr>
<tr class="memdesc:ga3056840a05520e3a5e1b77f8cdd373c4"><td class="mdescLeft"> </td><td class="mdescRight">Copies data from a referenced region to a region in a destination dataset. <br /></td></tr>
<tr class="separator:ga3056840a05520e3a5e1b77f8cdd373c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75787f84657d69421c6a8be57a9f070c" id="r_ga75787f84657d69421c6a8be57a9f070c"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga75787f84657d69421c6a8be57a9f070c">H5LRcreate_ref_to_all</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *group_path, const char *ds_path, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> index_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> ref_type)</td></tr>
<tr class="memdesc:ga75787f84657d69421c6a8be57a9f070c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a dataset with the region references to the data in all datasets located under a specified group in a file or creates a dataset with object references to all objects (groups or datasets) located under a specified group in a file. <br /></td></tr>
<tr class="separator:ga75787f84657d69421c6a8be57a9f070c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0cab2622e4ffba04c363d37b98b0a83b" id="r_ga0cab2622e4ffba04c363d37b98b0a83b"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0cab2622e4ffba04c363d37b98b0a83b">H5LRread_region</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, const <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *ref, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type, size_t *numelem, void *buf)</td></tr>
<tr class="memdesc:ga0cab2622e4ffba04c363d37b98b0a83b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves raw data pointed to by a region reference to an application buffer. <br /></td></tr>
<tr class="separator:ga0cab2622e4ffba04c363d37b98b0a83b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb053f246fd0cfcb588bafe98278b9b8" id="r_gabb053f246fd0cfcb588bafe98278b9b8"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabb053f246fd0cfcb588bafe98278b9b8">H5LRget_region_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, const <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *ref, size_t *len, char *path, int *rank, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> *dtype, <a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304">H5S_sel_type</a> *sel_type, size_t *numelem, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *buf)</td></tr>
<tr class="memdesc:gabb053f246fd0cfcb588bafe98278b9b8"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about the data a region reference points to. <br /></td></tr>
<tr class="separator:gabb053f246fd0cfcb588bafe98278b9b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga73fb3ab3e9b756a818e711cd335c819d" id="r_ga73fb3ab3e9b756a818e711cd335c819d"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga73fb3ab3e9b756a818e711cd335c819d">H5LTcopy_region</a> (const char *file_src, const char *path_src, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *block_coord_src, const char *file_dest, const char *path_dest, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *block_coord_dset)</td></tr>
<tr class="memdesc:ga73fb3ab3e9b756a818e711cd335c819d"><td class="mdescLeft"> </td><td class="mdescRight">Copies data from a specified region in a source dataset to a specified region in a destination dataset. <br /></td></tr>
<tr class="separator:ga73fb3ab3e9b756a818e711cd335c819d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga291c97f18425bb1136f1eab304fb0722" id="r_ga291c97f18425bb1136f1eab304fb0722"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga291c97f18425bb1136f1eab304fb0722">H5LTread_region</a> (const char *file, const char *path, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *block_coord, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type, void *buf)</td></tr>
<tr class="memdesc:ga291c97f18425bb1136f1eab304fb0722"><td class="mdescLeft"> </td><td class="mdescRight">Reads selected data to an application buffer. <br /></td></tr>
<tr class="separator:ga291c97f18425bb1136f1eab304fb0722"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1eec1ca149e662c4937e4ab10c30e0f6" id="r_ga1eec1ca149e662c4937e4ab10c30e0f6"><td class="memItemLeft" align="right" valign="top">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1eec1ca149e662c4937e4ab10c30e0f6">H5LTread_bitfield_value</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dset_id, int num_values, const unsigned *offset, const unsigned *lengths, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space, int *buf)</td></tr>
<tr class="memdesc:ga1eec1ca149e662c4937e4ab10c30e0f6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the values of quality flags for each element to the application provided buffer. <br /></td></tr>
<tr class="separator:ga1eec1ca149e662c4937e4ab10c30e0f6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga889b19b609e4e44565467cb84c6eeb0d" name="ga889b19b609e4e44565467cb84c6eeb0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga889b19b609e4e44565467cb84c6eeb0d">◆ </a></span>H5LRcopy_reference()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LRcopy_reference </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *</td> <td class="paramname"><span class="paramname"><em>ref</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>file</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>block_coord</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *</td> <td class="paramname"><span class="paramname"><em>ref_new</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies data from the specified dataset to a new location and creates a reference to it. </p>
<hr />
<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 any object in a file an HDF5 reference belongs to </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>Reference to the datasets region </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>Name of the destination file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Full path to the destination dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block_coord</td><td>Hyperslab coordinates in the destination dataset </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ref_new</td><td>Region reference to the new location of data</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>Given a data set pointed to by a region reference, the function <a class="el" href="#ga889b19b609e4e44565467cb84c6eeb0d" title="Copies data from the specified dataset to a new location and creates a reference to it.">H5LRcopy_reference()</a> will copy the hyperslab data referenced by a datasets region reference into existing dataset specified by its path <code>path</code> in the file with the name <code>file</code>, and to location specified by the hyperslab coordinates <code>block_coord</code>. It will create the region reference <code>ref_new</code> to point to the new location. The number of elements in the old and newly specified regions has to be the same.</p>
<p>Buffer <code>block_coord</code> has size 2*rank and is the coordinates of the starting point following by the coordinates of the ending point of the hyperslab. For example, to extract a rectangular hyperslab region starting at element (2,2) to element (5,4) then <code>block_coord</code> would be {2, 2, 5, 4}.</p>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl>
</div>
</div>
<a id="ga3056840a05520e3a5e1b77f8cdd373c4" name="ga3056840a05520e3a5e1b77f8cdd373c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3056840a05520e3a5e1b77f8cdd373c4">◆ </a></span>H5LRcopy_region()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LRcopy_region </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *</td> <td class="paramname"><span class="paramname"><em>ref</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>file</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>block_coord</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies data from a referenced region to a region in a destination dataset. </p>
<hr />
<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 any object in a file dataset region reference belongs to </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>Dataset region reference </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>Name of the destination file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Full path to the destination dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block_coord</td><td>Hyperslab coordinates in the destination dataset</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>Given a dataset region reference <code>ref</code> in a source file specified by an identifier of any object in that file <code>obj_id</code>, the function will write data to the existing dataset <code>path</code> in file <code>file</code> to the simple hyperslab specified by <code>block_coord</code>.</p>
<p>Buffer <code>block_coord</code> has size 2*rank and is the coordinates of the starting point following by the coordinates of the ending point of the hyperslab. For example, to specify a rectangular hyperslab destination region starting at element (2,2) to element (5,4) then <code>block_coord</code> would be {2, 2, 5, 4}.</p>
<p>If <code>path</code> does not exist in the destination file (as may be the case when writing to a new file) then the dataset will be copied directly to the <code>path</code> and <code>block_coord</code> will be disregarded.</p>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl>
</div>
</div>
<a id="ga75787f84657d69421c6a8be57a9f070c" name="ga75787f84657d69421c6a8be57a9f070c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga75787f84657d69421c6a8be57a9f070c">◆ </a></span>H5LRcreate_ref_to_all()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LRcreate_ref_to_all </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>ds_path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a></td> <td class="paramname"><span class="paramname"><em>index_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a></td> <td class="paramname"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a></td> <td class="paramname"><span class="paramname"><em>ref_type</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a dataset with the region references to the data in all datasets located under a specified group in a file or creates a dataset with object references to all objects (groups or datasets) located under a specified group in a file. </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 or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">group_path</td><td>Absolute or relative path to the group at which traversal starts </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ds_path</td><td>Absolute or relative path to the dataset with region references to be created </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index_type</td><td>Index_type; see valid values below in description </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Order in which index is traversed; see valid values below in description </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref_type</td><td>Reference type; see valid values below in description</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="#ga75787f84657d69421c6a8be57a9f070c" title="Creates a dataset with the region references to the data in all datasets located under a specified gr...">H5LRcreate_ref_to_all()</a> creates a dataset with the region references to the data in all datasets located under a specified group in a file or creates a dataset with object references to all objects (groups or datasets) located under a specified group in a file.</p>
<p>Given a dataset path <code>ds_path</code> in a file specified by the <code>loc_id</code> identifier, the function <a class="el" href="#ga75787f84657d69421c6a8be57a9f070c" title="Creates a dataset with the region references to the data in all datasets located under a specified gr...">H5LRcreate_ref_to_all()</a> will create a contiguous one-dimensional dataset with the region references or object references depending on the value of the <code>ref_type</code> parameter. When <code>ref_type</code> is <a class="el" href="_h5_rpublic_8h.html#a2a28c48c03a4616a02f9157fca4b2df0">H5R_DATASET_REGION</a>, each region reference points to all data in a dataset encountered by an internally called <a class="el" href="group___t_r_a_v.html#gac0558936502924d9e898d8b6e041ed69">H5Lvisit()</a> routine, which starts at the group specified by the <code>loc_id</code> and <code>group_path</code> parameters. In a like manner, when <code>ref_type</code> is <a class="el" href="_h5_rpublic_8h.html#ae1ffa09875ca6778df3a577592dacbd2">H5R_OBJECT</a>, each object reference points to an object (a group or a dataset) encountered by <a class="el" href="group___t_r_a_v.html#gac0558936502924d9e898d8b6e041ed69">H5Lvisit()</a>.</p>
<p>If <code>ds_path</code> does not exist in <code>loc_id</code> then the function will create the path specified by <code>ds_path</code> automatically.</p>
<p><code>index_type</code> specifies the index to be used. Valid values include the following:</p><ul>
<li><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a> Alphanumeric index on name</li>
<li><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a315475479b34056043b4b6583bafb280">H5_INDEX_CRT_ORDER</a> Index on creation order</li>
</ul>
<p><code>order</code> specifies the order in which objects are to be inspected along the index specified in <code>index_type</code>. Valid values include the following:</p><ul>
<li><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a> Increasing order</li>
<li><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a> Decreasing order</li>
<li><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a15eebaf7d85d5e37e918858634e29d01">H5_ITER_NATIVE</a> Fastest available order</li>
</ul>
<p>For more detailed information on these two parameters, </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group___t_r_a_v.html#gac0558936502924d9e898d8b6e041ed69">H5Lvisit()</a>.</dd></dl>
<p><code>ref_type</code> specifies the type of the reference to be used. Valid values include the following:</p><ul>
<li><a class="el" href="_h5_rpublic_8h.html#a2a28c48c03a4616a02f9157fca4b2df0">H5R_DATASET_REGION</a> Dataset region reference</li>
<li><a class="el" href="_h5_rpublic_8h.html#ae1ffa09875ca6778df3a577592dacbd2">H5R_OBJECT</a> Object reference</li>
</ul>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl>
</div>
</div>
<a id="gacef1564aa36bdfceac13b7b2bdd8e2d8" name="gacef1564aa36bdfceac13b7b2bdd8e2d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacef1564aa36bdfceac13b7b2bdd8e2d8">◆ </a></span>H5LRcreate_region_references()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LRcreate_region_references </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>num_elem</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **</td> <td class="paramname"><span class="paramname"><em>path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>block_coord</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an array of region references using an array of paths to datasets and an array of corresponding hyperslab descriptions. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>File identifier for the HDF5 file containing the referenced regions or an object identifier for any object in that file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num_elem</td><td>Number of elements in the <code>path</code> and <code>buf</code> arrays </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Array of pointers to strings, which contain the paths to the target datasets for the region references </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block_coord</td><td>Array of hyperslab coordinate </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer for returning an array of region references</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="section note"><dt>Note</dt><dd><b>Motivation:</b> </dd>
<dd>
<a class="el" href="#gacef1564aa36bdfceac13b7b2bdd8e2d8" title="Creates an array of region references using an array of paths to datasets and an array of correspondi...">H5LRcreate_region_references()</a> is useful when creating large numbers of similar region references.</dd></dl>
<p><a class="el" href="#gacef1564aa36bdfceac13b7b2bdd8e2d8" title="Creates an array of region references using an array of paths to datasets and an array of correspondi...">H5LRcreate_region_references()</a> creates a list of region references given an array of paths to datasets and another array listing the corner coordinates of the corresponding hyperslabs.</p>
<p><code>path</code> parameter is an array of pointers to strings.</p>
<p><code>num_elem</code> specifies the number of region references to be created, thus specifying the size of the <code>path</code> and <code>_buf</code> arrays.</p>
<p>Buffer <code>block_coord</code> has size 2*rank and is the coordinates of the starting point following by the coordinates of the ending point of the hyperslab, repeated <code>num_elem</code> times for each hyperslab. For example, creating two region references to two hyperslabs, one with a rectangular hyperslab region starting at element (2,2) to element (5,4) and the second rectangular region starting at element (7,7) to element (9,10), results in <code>block_coord</code> being {2,2,5,4, 7,7,9,10}.</p>
<p>The rank of the hyperslab will be the same as the rank of the target dataset. <a class="el" href="#gacef1564aa36bdfceac13b7b2bdd8e2d8" title="Creates an array of region references using an array of paths to datasets and an array of correspondi...">H5LRcreate_region_references()</a> will retrieve the rank for each dataset and will use those values to interpret the values in the buffer. Please note that rank may vary from one dataset to another.</p>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl>
</div>
</div>
<a id="gabb053f246fd0cfcb588bafe98278b9b8" name="gabb053f246fd0cfcb588bafe98278b9b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb053f246fd0cfcb588bafe98278b9b8">◆ </a></span>H5LRget_region_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LRget_region_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *</td> <td class="paramname"><span class="paramname"><em>ref</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>len</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>rank</em>, </span></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"><span class="paramname"><em>dtype</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304">H5S_sel_type</a> *</td> <td class="paramname"><span class="paramname"><em>sel_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>numelem</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves information about the data a region reference points to. </p>
<hr />
<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 any object in an HDF5 file the region reference belongs to. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>Region reference to query </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">len</td><td>Size of the buffer to store <code>path</code> in. NOTE: if <code>*path</code> is not NULL then <code>*len</code> must be the appropriate length </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">path</td><td>Full path that a region reference points to </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">rank</td><td>The number of dimensions of the dataset dimensions of the dataset pointed by region reference. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">dtype</td><td>Datatype of the dataset pointed by the region reference. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">sel_type</td><td>Type of the selection (point or hyperslab) </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">numelem</td><td>Number of coordinate blocks or selected elements. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer containing description of the region pointed by region reference</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="#gabb053f246fd0cfcb588bafe98278b9b8" title="Retrieves information about the data a region reference points to.">H5LRget_region_info()</a> queries information about the data pointed by a region reference <code>ref</code>. It returns one of the absolute paths to a dataset, length of the path, dataset's rank and datatype, description of the referenced region and type of the referenced region. Any output argument can be NULL if that argument does not need to be returned.</p>
<p>The parameter <code>obj_id</code> is an identifier for any object in the HDF5 file containing the referenced object. For example, it can be an identifier of a dataset the region reference belongs to or an identifier of an HDF5 file the dataset with region references is stored in.</p>
<p>The parameter <code>ref</code> is a region reference to query.</p>
<p>The parameter <code>path</code> is a pointer to application allocated buffer of size <code>len+1</code> to return an absolute path to a dataset the region reference points to.</p>
<p>The parameter <code>len</code> is a length of absolute path string plus the \0 string terminator. If path parameter is NULL, actual length of the path (+1 for \0 string terminator) is returned to application and can be used to allocate buffer path of an appropriate length <code>len</code>.</p>
<p>The parameter <code>sel_type</code> describes the type of the selected region. Possible values can be <a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304a858daf05b19591a8f5d6ffbee281f81c">H5S_SEL_POINTS</a> for point selection and <a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304aeb9dc925cd7c6a6702fc9c766e20b01a">H5S_SEL_HYPERSLABS</a> for hyperslab selection.</p>
<p>The parameter <code>numelem</code> describes how many elements will be placed in the buffer <code>buf</code>. The number should be interpreted using the value of <code>sel_type</code>.</p>
<p>If value of <code>sel_type</code> is <a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304aeb9dc925cd7c6a6702fc9c766e20b01a">H5S_SEL_HYPERSLABS</a>, the parameter <code>buf</code> contains <code>numelem</code> blocks of the coordinates for each simple hyperslab of the referenced region. Each block has length <code>2*<code>rank</code> and</code> is organized as follows: <"start" coordinate>, immediately followed by <"opposite" corner coordinate>. The total size of the buffer to hold the description of the region will be <code>2*<code>rank*<code>numelem</code>.</code> If</code> region reference points to a contiguous sub-array, then the value of <code>numelem</code> is 1 and the block contains coordinates of the upper left and lower right corners of the sub-array (or simple hyperslab).</p>
<p>If value of <code>sel_type</code> is <a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304a858daf05b19591a8f5d6ffbee281f81c">H5S_SEL_POINTS</a>, the parameter <code>buf</code> contains <code>numelem</code> blocks of the coordinates for each selected point of the referenced region. Each block has length <code>rank</code> and contains coordinates of the element. The total size of the buffer to hold the description of the region will be <code>rank*</code> <code>numelem</code>.</p>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl>
</div>
</div>
<a id="gabbf9f8ea4d13d44d45efae5e143a157a" name="gabbf9f8ea4d13d44d45efae5e143a157a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabbf9f8ea4d13d44d45efae5e143a157a">◆ </a></span>H5LRmake_dataset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LRmake_dataset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>path</em>, </span></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"><span class="paramname"><em>type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t</td> <td class="paramname"><span class="paramname"><em>buf_size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> *</td> <td class="paramname"><span class="paramname"><em>loc_id_ref</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates and writes a dataset containing a list of region references. </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">path</td><td>Path to the dataset being created </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype of the dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf_size</td><td>Size of the <code>loc_id_ref</code> and <code>buf</code> arrays </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id_ref</td><td>Array of object identifiers; each identifier describes to which HDF5 file the corresponding region reference belongs to </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Array of region references</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>Given an array of size <code>buf_size</code> of region references <code>buf</code>, the function will create a dataset with path <code>path</code>, at location specified by <code>loc_id</code> and of a datatype specified by <code>type_id</code>, and will write data associated with each region reference in the order corresponding to the order of the region references in the buffer. It is assumed that all referenced hyperslabs have the same dimensionality, and only the size of the slowest changing dimension may differ. Each reference in the <code>buf</code> array belongs to the file identified by the corresponding object identifiers in the array <code>loc_id_ref</code>.</p>
<p>If <code>path</code> does not exist in <code>loc_id</code> then the function will create the path specified by <code>path</code> automatically.</p>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl>
</div>
</div>
<a id="ga0cab2622e4ffba04c363d37b98b0a83b" name="ga0cab2622e4ffba04c363d37b98b0a83b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0cab2622e4ffba04c363d37b98b0a83b">◆ </a></span>H5LRread_region()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LRread_region </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structhdset__reg__ref__t.html">hdset_reg_ref_t</a> *</td> <td class="paramname"><span class="paramname"><em>ref</em>, </span></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"><span class="paramname"><em>mem_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>numelem</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>buf</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves raw data pointed to by a region reference to an application buffer. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>File identifier for the HDF5 file containing the dataset with the referenced region or an object identifier for any object in that file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>Region reference specifying data to be read in </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mem_type</td><td>Memory datatype of data read from referenced region into the application buffer </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">numelem</td><td>Number of elements to be read into buffer <code>buf</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer in which data is returned to the application</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="#ga0cab2622e4ffba04c363d37b98b0a83b" title="Retrieves raw data pointed to by a region reference to an application buffer.">H5LRread_region()</a> reads data pointed to by the region reference <code>ref</code> into the buffer <code>buf</code>.</p>
<p><code>numelem</code> specifies the number of elements to be read into <code>buf</code>. When the size of the reference region is unknown, <a class="el" href="#ga0cab2622e4ffba04c363d37b98b0a83b" title="Retrieves raw data pointed to by a region reference to an application buffer.">H5LRread_region()</a> can be called with <code>buf</code> set to NULL; the number of elements in the referenced region will be returned in <code>numelem</code>.</p>
<p>The buffer buf must be big enough to hold <code>numelem</code> elements of type <code>mem_type</code>. For example, if data is read from the referenced region into an integer buffer, <code>mem_type</code> should be <a class="el" href="group___p_d_t_n_a_t.html#ga3cf93ffc6782be68070ef8e00f219ec2">H5T_NATIVE_INT</a> and the buffer must be at least <code>sizeof(int)</code> * <code>numelem</code> bytes in size. This buffer must be allocated by the application.</p>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl>
</div>
</div>
<a id="ga73fb3ab3e9b756a818e711cd335c819d" name="ga73fb3ab3e9b756a818e711cd335c819d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga73fb3ab3e9b756a818e711cd335c819d">◆ </a></span>H5LTcopy_region()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LTcopy_region </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>file_src</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>path_src</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>block_coord_src</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>file_dest</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>path_dest</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>block_coord_dset</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies data from a specified region in a source dataset to a specified region in a destination dataset. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">file_src</td><td>Name of the source file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">path_src</td><td>Full path to the source dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block_coord_src</td><td>Hyperslab coordinates in the source dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file_dest</td><td>Name of the destination file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">path_dest</td><td>Full path to the destination dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block_coord_dset</td><td>Hyperslab coordinates in the destination dataset</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>Given a path to a dataset <code>path_src</code> in a file with the name <code>file_src</code>, and description of a simple hyperslab of the source <code>block_coord_src</code>, the function will write data to the dataset <code>path_dest</code> in file <code>file_dest</code> to the simple hyperslab specified by <code>block_coord_dset</code>. The arrays <code>block_coord_src</code> and <code>block_coord_dset</code> have a length of 2*rank and are the coordinates of the starting point following by the coordinates of the ending point of the hyperslab. For example, to specify a rectangular hyperslab destination region starting at element (2,2) to element (5,4) then <code>block_coord_dset</code> would be {2, 2, 5, 4}.</p>
<p>If <code>path_dest</code> does not exist in the destination file (as may be the case when writing to a new file) then the dataset will be copied directly to the <code>path_dest</code> and <code>block_coord_dset</code> will be disregarded.</p>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl>
</div>
</div>
<a id="ga1eec1ca149e662c4937e4ab10c30e0f6" name="ga1eec1ca149e662c4937e4ab10c30e0f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1eec1ca149e662c4937e4ab10c30e0f6">◆ </a></span>H5LTread_bitfield_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LTread_bitfield_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dset_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>num_values</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned *</td> <td class="paramname"><span class="paramname"><em>offset</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned *</td> <td class="paramname"><span class="paramname"><em>lengths</em>, </span></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"><span class="paramname"><em>space</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>buf</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the values of quality flags for each element to the application provided buffer. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dset_id</td><td>Identifier of the dataset with bit-field values </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num_values</td><td>Number of the values to be extracted </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Array of staring bits to be extracted from the element; valid values: 0 (zero) through 7 </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lengths</td><td>Array of the number of bits to be extracted for each value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">space</td><td>Dataspace identifier, describing the elements to be read from the dataset with bit-field values </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to read the values in</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="#ga1eec1ca149e662c4937e4ab10c30e0f6" title="Retrieves the values of quality flags for each element to the application provided buffer.">H5LTread_bitfield_value()</a> reads selected elements from a dataset specified by its identifier <code>dset_id</code>, and unpacks the bit-field values to a buffer <code>buf</code>.</p>
<p>The parameter <code>space</code> is a space identifier that indicates which elements of the dataset should be read.</p>
<p>The parameter <code>offset</code> is an array of length <code>num_values</code>; the i<sup>th</sup> element of the array holds the value of the starting bit of the i<sup>th</sup> bit-field value. Valid values are: 0 (zero) through 7.</p>
<p>The parameter <code>lengths</code> is an array of length <code>num_values</code>; the i<sup>th</sup> element of the array holds the number of bits to be extracted for the i<sup>th</sup> bit-field value. Extracted bits will be interpreted as a base-2 integer value. Each value will be converted to the base-10 integer value and stored in the application buffer.</p>
<p>Buffer <code>buf</code> is allocated by the application and should be big enough to hold <code>num_sel_elem</code> * <code>num_values</code> elements of the specified type, where <code>num_sel_elem</code> is a number of the elements to be read from the dataset. Data in the buffer is organized as <code>num_values</code> values for the first element, followed by the <code>num_values</code> values for the second element, ... , followed by the <code>num_values</code> values for the <code>num_selected_elem<sup>th</sup></code> element.</p>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl>
</div>
</div>
<a id="ga291c97f18425bb1136f1eab304fb0722" name="ga291c97f18425bb1136f1eab304fb0722"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga291c97f18425bb1136f1eab304fb0722">◆ </a></span>H5LTread_region()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLRDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5LTread_region </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>file</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>block_coord</em>, </span></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"><span class="paramname"><em>mem_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>buf</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads selected data to an application buffer. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>Name of file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Full path to a dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block_coord</td><td>Hyperslab coordinates </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mem_type</td><td>Memory datatype, describing the buffer the referenced data will be read into </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer containing data from the referenced region</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="#ga291c97f18425bb1136f1eab304fb0722" title="Reads selected data to an application buffer.">H5LTread_region()</a> reads data from a region described by the hyperslab coordinates in <code>block_coord</code>, located in the dataset specified by its absolute path <code>path</code> in a file specified by its name <code>file</code>. Data is read into a buffer <code>buf</code> of the datatype that corresponds to the HDF5 datatype specified by <code>mem_type</code>.</p>
<p>Buffer <code>block_coord</code> has size 2*rank and is the coordinates of the starting point following by the coordinates of the ending point of the hyperslab. For example, to extract a rectangular hyperslab region starting at element (2,2) to element (5,4) then <code>block_coord</code> would be {2, 2, 5, 4}.</p>
<p>Buffer <code>buf</code> should be big enough to hold selected elements of the type that corresponds to the <code>mem_type</code> </p>
<dl class="section version"><dt>Version</dt><dd>1.1 Fortran wrapper introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.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.10.0 </li>
</ul>
</div>
</body>
</html>
|
