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
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
|
<!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: VOL Mapping (H5M)</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.68e8c0e</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_m.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<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">VOL Mapping (H5M)</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>The interface can only be used with the HDF5 VOL connectors that implement map objects.</b> The native HDF5 library does not support this feature.</p>
<p>While the HDF5 data model is a flexible way to store data, some applications require a more general way to index information. HDF5 effectively uses key-value stores internally for a variety of purposes, but it does not expose a generic key-value store to the API. The Map APIs provide this capability to the HDF5 applications in the form of HDF5 map objects. These Map objects contain application-defined key-value stores, to which key-value pairs can be added, and from which values can be retrieved by key.</p>
<p>HDF5 VOL connectors with support for map objects:</p><ul>
<li>DAOS</li>
</ul>
<dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, fapl_id, map_id, vls_type_id;</div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *names[2] = [<span class="stringliteral">"Alice"</span>, <span class="stringliteral">"Bob"</span>];</div>
<div class="line">uint64_t IDs[2] = [25385486, 34873275];</div>
<div class="line">uint64_t val_out;</div>
<div class="line"> </div>
<div class="line"><HDF5 VOL setup code ....></div>
<div class="line"> </div>
<div class="line">vls_type_id = <a class="code hl_function" href="group___h5_t.html#gaec07efbab84f4e5b4ed22f010786be8e">H5Tcopy</a>(<a class="code hl_define" href="group___p_d_t_s.html#ga7f6b6959fefe56d2e871659110936d2d">H5T_C_S1</a>);</div>
<div class="line"><a class="code hl_function" href="group___h5_t.html#gae5f38bfd4a4c557496b3194b5180212c">H5Tset_size</a>(vls_type_id, <a class="code hl_define" href="_h5_tpublic_8h.html#a5185e14efde13b48249fe391324331bc">H5T_VARIABLE</a>);</div>
<div class="line">file_id = <a class="code hl_function" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a>(<span class="stringliteral">"file.h5"</span>, <a class="code hl_define" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, fapl_id);</div>
<div class="line">map_id = <a class="code hl_function" href="#gac85972f70201429a93184408d40e4b09">H5Mcreate</a>(file_id, <span class="stringliteral">"map"</span>, vls_type_id, <a class="code hl_define" href="group___p_d_t_c9x.html#ga5eda31dcf868e6b9487d1486ec4a5613">H5T_NATIVE_UINT64</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"><a class="code hl_function" href="#ga8cb388b30893cb79ed4d2bec4a8e8c4f">H5Mput</a>(map_id, vls_type_id, &names[0], <a class="code hl_define" href="group___p_d_t_c9x.html#ga5eda31dcf868e6b9487d1486ec4a5613">H5T_NATIVE_UINT64</a>, &IDs[0], <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"><a class="code hl_function" href="#ga8cb388b30893cb79ed4d2bec4a8e8c4f">H5Mput</a>(map_id, vls_type_id, &names[1], <a class="code hl_define" href="group___p_d_t_c9x.html#ga5eda31dcf868e6b9487d1486ec4a5613">H5T_NATIVE_UINT64</a>, &IDs[1], <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"><a class="code hl_function" href="#ga585b7c3352cbca858e11bf50d3dd68ed">H5Mget</a>(map_id, vls_type_id, &names[0], <a class="code hl_define" href="group___p_d_t_c9x.html#ga5eda31dcf868e6b9487d1486ec4a5613">H5T_NATIVE_UINT64</a>, &val_out, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"><span class="keywordflow">if</span>(val_out != IDs[0])</div>
<div class="line"> ERROR;</div>
<div class="line"><a class="code hl_function" href="#gad9a6a1199edc0fb4a50d831a213a5f44">H5Mclose</a>(map_id);</div>
<div class="line"><a class="code hl_function" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0">H5Tclose</a>(vls_type_id);</div>
<div class="line"><a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file_id);</div>
<div class="ttc" id="a_h5_fpublic_8h_html_a5a2d6726f9ad8d2bca8df2b817e5ad6a"><div class="ttname"><a href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a></div><div class="ttdeci">#define H5F_ACC_TRUNC</div><div class="ttdef"><b>Definition</b> H5Fpublic.h:50</div></div>
<div class="ttc" id="a_h5_ipublic_8h_html_a0045db7ff9c22ad35db6ae91662e1943"><div class="ttname"><a href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></div><div class="ttdeci">int64_t hid_t</div><div class="ttdef"><b>Definition</b> H5Ipublic.h:60</div></div>
<div class="ttc" id="a_h5_ppublic_8h_html_afa85e97bfbf9bf1c58e39263846c568f"><div class="ttname"><a href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a></div><div class="ttdeci">#define H5P_DEFAULT</div><div class="ttdef"><b>Definition</b> H5Ppublic.h:102</div></div>
<div class="ttc" id="a_h5_tpublic_8h_html_a5185e14efde13b48249fe391324331bc"><div class="ttname"><a href="_h5_tpublic_8h.html#a5185e14efde13b48249fe391324331bc">H5T_VARIABLE</a></div><div class="ttdeci">#define H5T_VARIABLE</div><div class="ttdef"><b>Definition</b> H5Tpublic.h:207</div></div>
<div class="ttc" id="agroup___h5_f_html_gac55cd91d80822e4f8c2a7f04ea71b124"><div class="ttname"><a href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a></div><div class="ttdeci">herr_t H5Fclose(hid_t file_id)</div><div class="ttdoc">Terminates access to an HDF5 file.</div></div>
<div class="ttc" id="agroup___h5_f_html_gae64b51ee9ac0781bc4ccc599d98387f4"><div class="ttname"><a href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a></div><div class="ttdeci">hid_t H5Fcreate(const char *filename, unsigned flags, hid_t fcpl_id, hid_t fapl_id)</div><div class="ttdoc">Creates an HDF5 file.</div></div>
<div class="ttc" id="agroup___h5_m_html_ga585b7c3352cbca858e11bf50d3dd68ed"><div class="ttname"><a href="#ga585b7c3352cbca858e11bf50d3dd68ed">H5Mget</a></div><div class="ttdeci">herr_t H5Mget(hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, void *value, hid_t dxpl_id)</div><div class="ttdoc">Retrieves a key-value pair from a map object.</div></div>
<div class="ttc" id="agroup___h5_m_html_ga8cb388b30893cb79ed4d2bec4a8e8c4f"><div class="ttname"><a href="#ga8cb388b30893cb79ed4d2bec4a8e8c4f">H5Mput</a></div><div class="ttdeci">herr_t H5Mput(hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, const void *value, hid_t dxpl_id)</div><div class="ttdoc">Adds a key-value pair to a map object.</div></div>
<div class="ttc" id="agroup___h5_m_html_gac85972f70201429a93184408d40e4b09"><div class="ttname"><a href="#gac85972f70201429a93184408d40e4b09">H5Mcreate</a></div><div class="ttdeci">hid_t H5Mcreate(hid_t loc_id, const char *name, hid_t key_type_id, hid_t val_type_id, hid_t lcpl_id, hid_t mcpl_id, hid_t mapl_id)</div><div class="ttdoc">Creates a map object.</div></div>
<div class="ttc" id="agroup___h5_m_html_gad9a6a1199edc0fb4a50d831a213a5f44"><div class="ttname"><a href="#gad9a6a1199edc0fb4a50d831a213a5f44">H5Mclose</a></div><div class="ttdeci">herr_t H5Mclose(hid_t map_id)</div><div class="ttdoc">Terminates access to a map object.</div></div>
<div class="ttc" id="agroup___h5_t_html_gae5f38bfd4a4c557496b3194b5180212c"><div class="ttname"><a href="group___h5_t.html#gae5f38bfd4a4c557496b3194b5180212c">H5Tset_size</a></div><div class="ttdeci">herr_t H5Tset_size(hid_t type_id, size_t size)</div><div class="ttdoc">Sets size for a datatype.</div></div>
<div class="ttc" id="agroup___h5_t_html_gaec07efbab84f4e5b4ed22f010786be8e"><div class="ttname"><a href="group___h5_t.html#gaec07efbab84f4e5b4ed22f010786be8e">H5Tcopy</a></div><div class="ttdeci">hid_t H5Tcopy(hid_t type_id)</div><div class="ttdoc">Copies an existing datatype.</div></div>
<div class="ttc" id="agroup___h5_t_html_gafcba4db244f6a4d71e99c6e72b8678f0"><div class="ttname"><a href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0">H5Tclose</a></div><div class="ttdeci">herr_t H5Tclose(hid_t type_id)</div><div class="ttdoc">Releases a datatype.</div></div>
<div class="ttc" id="agroup___p_d_t_c9x_html_ga5eda31dcf868e6b9487d1486ec4a5613"><div class="ttname"><a href="group___p_d_t_c9x.html#ga5eda31dcf868e6b9487d1486ec4a5613">H5T_NATIVE_UINT64</a></div><div class="ttdeci">#define H5T_NATIVE_UINT64</div><div class="ttdef"><b>Definition</b> H5Tpublic.h:983</div></div>
<div class="ttc" id="agroup___p_d_t_s_html_ga7f6b6959fefe56d2e871659110936d2d"><div class="ttname"><a href="group___p_d_t_s.html#ga7f6b6959fefe56d2e871659110936d2d">H5T_C_S1</a></div><div class="ttdeci">#define H5T_C_S1</div><div class="ttdef"><b>Definition</b> H5Tpublic.h:476</div></div>
</div><!-- fragment --> </dd></dl>
<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:gac85972f70201429a93184408d40e4b09" id="r_gac85972f70201429a93184408d40e4b09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac85972f70201429a93184408d40e4b09">H5Mcreate</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> key_type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> val_type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mapl_id)</td></tr>
<tr class="memdesc:gac85972f70201429a93184408d40e4b09"><td class="mdescLeft"> </td><td class="mdescRight">Creates a map object. <br /></td></tr>
<tr class="separator:gac85972f70201429a93184408d40e4b09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga978881a6ecbacc418232d318549307f2" id="r_ga978881a6ecbacc418232d318549307f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga978881a6ecbacc418232d318549307f2">H5Mcreate_anon</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> key_type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> val_type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mapl_id)</td></tr>
<tr class="separator:ga978881a6ecbacc418232d318549307f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga426fbeac4c90849f2ac1855447fb8d43" id="r_ga426fbeac4c90849f2ac1855447fb8d43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga426fbeac4c90849f2ac1855447fb8d43">H5Mopen</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mapl_id)</td></tr>
<tr class="memdesc:ga426fbeac4c90849f2ac1855447fb8d43"><td class="mdescLeft"> </td><td class="mdescRight">Opens a map object. <br /></td></tr>
<tr class="separator:ga426fbeac4c90849f2ac1855447fb8d43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad9a6a1199edc0fb4a50d831a213a5f44" id="r_gad9a6a1199edc0fb4a50d831a213a5f44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad9a6a1199edc0fb4a50d831a213a5f44">H5Mclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id)</td></tr>
<tr class="memdesc:gad9a6a1199edc0fb4a50d831a213a5f44"><td class="mdescLeft"> </td><td class="mdescRight">Terminates access to a map object. <br /></td></tr>
<tr class="separator:gad9a6a1199edc0fb4a50d831a213a5f44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2001636fe6ce4c8aed13fa768c76a8fc" id="r_ga2001636fe6ce4c8aed13fa768c76a8fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2001636fe6ce4c8aed13fa768c76a8fc">H5Mget_key_type</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id)</td></tr>
<tr class="memdesc:ga2001636fe6ce4c8aed13fa768c76a8fc"><td class="mdescLeft"> </td><td class="mdescRight">Gets key datatype for a map object. <br /></td></tr>
<tr class="separator:ga2001636fe6ce4c8aed13fa768c76a8fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3c88ee008fa4ac1fa3b7824f182afc45" id="r_ga3c88ee008fa4ac1fa3b7824f182afc45"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3c88ee008fa4ac1fa3b7824f182afc45">H5Mget_val_type</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id)</td></tr>
<tr class="memdesc:ga3c88ee008fa4ac1fa3b7824f182afc45"><td class="mdescLeft"> </td><td class="mdescRight">Gets value datatype for a map object. <br /></td></tr>
<tr class="separator:ga3c88ee008fa4ac1fa3b7824f182afc45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d05e2962702d80d27643abc05ee3da7" id="r_ga5d05e2962702d80d27643abc05ee3da7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5d05e2962702d80d27643abc05ee3da7">H5Mget_create_plist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id)</td></tr>
<tr class="memdesc:ga5d05e2962702d80d27643abc05ee3da7"><td class="mdescLeft"> </td><td class="mdescRight">Gets creation property list for a map object. <br /></td></tr>
<tr class="separator:ga5d05e2962702d80d27643abc05ee3da7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga48dd6941c1cac4f8f0f3beaf01c5d7de" id="r_ga48dd6941c1cac4f8f0f3beaf01c5d7de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga48dd6941c1cac4f8f0f3beaf01c5d7de">H5Mget_access_plist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id)</td></tr>
<tr class="memdesc:ga48dd6941c1cac4f8f0f3beaf01c5d7de"><td class="mdescLeft"> </td><td class="mdescRight">Gets access property list for a map object. <br /></td></tr>
<tr class="separator:ga48dd6941c1cac4f8f0f3beaf01c5d7de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1c6119224bdb84e4254f772bbee08ac0" id="r_ga1c6119224bdb84e4254f772bbee08ac0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1c6119224bdb84e4254f772bbee08ac0">H5Mget_count</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *count, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id)</td></tr>
<tr class="memdesc:ga1c6119224bdb84e4254f772bbee08ac0"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of key-value pairs in a map object. <br /></td></tr>
<tr class="separator:ga1c6119224bdb84e4254f772bbee08ac0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8cb388b30893cb79ed4d2bec4a8e8c4f" id="r_ga8cb388b30893cb79ed4d2bec4a8e8c4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8cb388b30893cb79ed4d2bec4a8e8c4f">H5Mput</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> key_mem_type_id, const void *key, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> val_mem_type_id, const void *value, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id)</td></tr>
<tr class="memdesc:ga8cb388b30893cb79ed4d2bec4a8e8c4f"><td class="mdescLeft"> </td><td class="mdescRight">Adds a key-value pair to a map object. <br /></td></tr>
<tr class="separator:ga8cb388b30893cb79ed4d2bec4a8e8c4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga585b7c3352cbca858e11bf50d3dd68ed" id="r_ga585b7c3352cbca858e11bf50d3dd68ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga585b7c3352cbca858e11bf50d3dd68ed">H5Mget</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> key_mem_type_id, const void *key, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> val_mem_type_id, void *value, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id)</td></tr>
<tr class="memdesc:ga585b7c3352cbca858e11bf50d3dd68ed"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a key-value pair from a map object. <br /></td></tr>
<tr class="separator:ga585b7c3352cbca858e11bf50d3dd68ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga513a77497d24ecc765ad40b575cf7b1b" id="r_ga513a77497d24ecc765ad40b575cf7b1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga513a77497d24ecc765ad40b575cf7b1b">H5Mexists</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> key_mem_type_id, const void *key, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *exists, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id)</td></tr>
<tr class="memdesc:ga513a77497d24ecc765ad40b575cf7b1b"><td class="mdescLeft"> </td><td class="mdescRight">Checks if provided key exists in a map object. <br /></td></tr>
<tr class="separator:ga513a77497d24ecc765ad40b575cf7b1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaff5dc81a8a1150acee7e729a7747f1f2" id="r_gaff5dc81a8a1150acee7e729a7747f1f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2">H5Miterate</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *idx, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> key_mem_type_id, <a class="el" href="_h5_mpublic_8h.html#a689d878943fd9f1844809def5cfa60fe">H5M_iterate_t</a> op, void *op_data, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id)</td></tr>
<tr class="memdesc:gaff5dc81a8a1150acee7e729a7747f1f2"><td class="mdescLeft"> </td><td class="mdescRight">Iterates over all key-value pairs in a map object. <br /></td></tr>
<tr class="separator:gaff5dc81a8a1150acee7e729a7747f1f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9318fe7ee18d5630ad831868675c7ce9" id="r_ga9318fe7ee18d5630ad831868675c7ce9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9318fe7ee18d5630ad831868675c7ce9">H5Miterate_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *map_name, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *idx, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> key_mem_type_id, <a class="el" href="_h5_mpublic_8h.html#a689d878943fd9f1844809def5cfa60fe">H5M_iterate_t</a> op, void *op_data, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga9318fe7ee18d5630ad831868675c7ce9"><td class="mdescLeft"> </td><td class="mdescRight">Iterates over all key-value pairs in a map object. <br /></td></tr>
<tr class="separator:ga9318fe7ee18d5630ad831868675c7ce9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae3cd428dc0746052779e7e372bfd2cad" id="r_gae3cd428dc0746052779e7e372bfd2cad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae3cd428dc0746052779e7e372bfd2cad">H5Mdelete</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> key_mem_type_id, const void *key, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id)</td></tr>
<tr class="memdesc:gae3cd428dc0746052779e7e372bfd2cad"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a key-value pair from a map object. <br /></td></tr>
<tr class="separator:gae3cd428dc0746052779e7e372bfd2cad"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad9a6a1199edc0fb4a50d831a213a5f44" name="gad9a6a1199edc0fb4a50d831a213a5f44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad9a6a1199edc0fb4a50d831a213a5f44">◆ </a></span>H5Mclose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Mclose </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>map_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates access to a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gad9a6a1199edc0fb4a50d831a213a5f44" title="Terminates access to a map object.">H5Mclose()</a> closes access to a map object specified by <code>map_id</code> and releases resources used by it.</p>
<p>It is illegal to subsequently use that same map identifier in calls to other map functions.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="gac85972f70201429a93184408d40e4b09" name="gac85972f70201429a93184408d40e4b09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac85972f70201429a93184408d40e4b09">◆ </a></span>H5Mcreate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Mcreate </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>name</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>key_type_id</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>val_type_id</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>lcpl_id</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>mcpl_id</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>mapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Map object name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">val_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mcpl_id</td><td>Map creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mapl_id</td><td>Map access property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a map object identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#gac85972f70201429a93184408d40e4b09" title="Creates a map object.">H5Mcreate()</a> creates a new map object for storing key-value pairs. The in-file datatype for keys is defined by <code>key_type_id</code> and the in-file datatype for values is defined by <code>val_type_id</code>. <code>loc_id</code> specifies the location to create the map object and <code>name</code> specifies the name of the link to the map object relative to <code>loc_id</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga978881a6ecbacc418232d318549307f2" name="ga978881a6ecbacc418232d318549307f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga978881a6ecbacc418232d318549307f2">◆ </a></span>H5Mcreate_anon()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Mcreate_anon </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"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>key_type_id</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>val_type_id</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>mcpl_id</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>mapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="gae3cd428dc0746052779e7e372bfd2cad" name="gae3cd428dc0746052779e7e372bfd2cad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae3cd428dc0746052779e7e372bfd2cad">◆ </a></span>H5Mdelete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Mdelete </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>map_id</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>key_mem_type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>key</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>dxpl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes a key-value pair from a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_mem_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>Pointer to key buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gae3cd428dc0746052779e7e372bfd2cad" title="Deletes a key-value pair from a map object.">H5Mdelete()</a> deletes a key-value pair from the map object specified by <code>map_id</code>. <code>key_mem_type_id</code> specifies the datatype for the provided key buffer key, and if different from that used to create the map object, the key will be internally converted to the datatype for the map object.</p>
<p>Any further options can be specified through the property list <code>dxpl_id</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga513a77497d24ecc765ad40b575cf7b1b" name="ga513a77497d24ecc765ad40b575cf7b1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga513a77497d24ecc765ad40b575cf7b1b">◆ </a></span>H5Mexists()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Mexists </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>map_id</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>key_mem_type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>key</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *</td> <td class="paramname"><span class="paramname"><em>exists</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>dxpl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if provided key exists in a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_mem_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>Pointer to key buffer </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">exists</td><td>Pointer to a buffer to return the existence status </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga513a77497d24ecc765ad40b575cf7b1b" title="Checks if provided key exists in a map object.">H5Mexists()</a> checks if the provided key is stored in the map object specified by <code>map_id</code>. If <code>key_mem_type_id</code> is different from that used to create the map object the key will be internally converted to the datatype for the map object for the query.</p>
<p>Any further options can be specified through the property list <code>dxpl_id</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga585b7c3352cbca858e11bf50d3dd68ed" name="ga585b7c3352cbca858e11bf50d3dd68ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga585b7c3352cbca858e11bf50d3dd68ed">◆ </a></span>H5Mget()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Mget </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>map_id</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>key_mem_type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>key</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>val_mem_type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>value</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>dxpl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a key-value pair from a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_mem_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>Pointer to key buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">val_mem_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>Pointer to value buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga585b7c3352cbca858e11bf50d3dd68ed" title="Retrieves a key-value pair from a map object.">H5Mget()</a> retrieves from a map object specified by <code>map_id</code>, the value associated with the provided key <code>key</code>. <code>key_mem_type_id</code> and <code>val_mem_type_id</code> specify the datatypes for the provided key and value buffers. If if the datatype specified by <code>key_mem_type_id</code> is different from that used to create the map object the key will be internally converted to the datatype for the map object for the query, and if the datatype specified by <code>val_mem_type_id</code> is different from that used to create the map object the returned value will be converted to have a datatype as specified by <code>val_mem_type_id</code> before the function returns.</p>
<p>Any further options can be specified through the property list <code>dxpl_id</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga48dd6941c1cac4f8f0f3beaf01c5d7de" name="ga48dd6941c1cac4f8f0f3beaf01c5d7de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga48dd6941c1cac4f8f0f3beaf01c5d7de">◆ </a></span>H5Mget_access_plist()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Mget_access_plist </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>map_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets access property list for a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a map access property list identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga48dd6941c1cac4f8f0f3beaf01c5d7de" title="Gets access property list for a map object.">H5Mget_access_plist()</a> returns an identifier for a copy of the access property list for a map object specified by <code>map_id</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga1c6119224bdb84e4254f772bbee08ac0" name="ga1c6119224bdb84e4254f772bbee08ac0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c6119224bdb84e4254f772bbee08ac0">◆ </a></span>H5Mget_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Mget_count </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>map_id</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>count</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>dxpl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the number of key-value pairs in a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">count</td><td>The number of key-value pairs stored in the map object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga1c6119224bdb84e4254f772bbee08ac0" title="Retrieves the number of key-value pairs in a map object.">H5Mget_count()</a> retrieves the number of key-value pairs stored in a map specified by map_id.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga5d05e2962702d80d27643abc05ee3da7" name="ga5d05e2962702d80d27643abc05ee3da7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d05e2962702d80d27643abc05ee3da7">◆ </a></span>H5Mget_create_plist()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Mget_create_plist </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>map_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets creation property list for a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a map creation property list identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga5d05e2962702d80d27643abc05ee3da7" title="Gets creation property list for a map object.">H5Mget_create_plist()</a> returns an identifier for a copy of the creation property list for a map object specified by <code>map_id</code>.</p>
<p>The creation property list identifier should be released with <a class="el" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb" title="Terminates access to a property list.">H5Pclose()</a> to prevent resource leaks.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga2001636fe6ce4c8aed13fa768c76a8fc" name="ga2001636fe6ce4c8aed13fa768c76a8fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2001636fe6ce4c8aed13fa768c76a8fc">◆ </a></span>H5Mget_key_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Mget_key_type </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>map_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets key datatype for a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a datatype identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga2001636fe6ce4c8aed13fa768c76a8fc" title="Gets key datatype for a map object.">H5Mget_key_type()</a> retrieves key datatype as stored in the file for a map object specified by <code>map_id</code> and returns identifier for the datatype.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga3c88ee008fa4ac1fa3b7824f182afc45" name="ga3c88ee008fa4ac1fa3b7824f182afc45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3c88ee008fa4ac1fa3b7824f182afc45">◆ </a></span>H5Mget_val_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Mget_val_type </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>map_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets value datatype for a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a datatype identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga3c88ee008fa4ac1fa3b7824f182afc45" title="Gets value datatype for a map object.">H5Mget_val_type()</a> retrieves value datatype as stored in the file for a map object specified by <code>map_id</code> and returns identifier for the datatype .</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="gaff5dc81a8a1150acee7e729a7747f1f2" name="gaff5dc81a8a1150acee7e729a7747f1f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaff5dc81a8a1150acee7e729a7747f1f2">◆ </a></span>H5Miterate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Miterate </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>map_id</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>idx</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>key_mem_type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_mpublic_8h.html#a689d878943fd9f1844809def5cfa60fe">H5M_iterate_t</a></td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>op_data</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>dxpl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates over all key-value pairs in a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>iteration index </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_mem_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>User-defined iterator function </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">op_data</td><td>User-defined callback function context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2" title="Iterates over all key-value pairs in a map object.">H5Miterate()</a> iterates over all key-value pairs stored in the map object specified by <code>map_id</code>, making the callback specified by <code>op</code> for each. The <code>idx</code> parameter is an in/out parameter that may be used to restart a previously interrupted iteration. At the start of iteration <code>idx</code> should be set to 0, and to restart iteration at the same location on a subsequent call to <a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2" title="Iterates over all key-value pairs in a map object.">H5Miterate()</a>, <code>idx</code> should be the same value as returned by the previous call. Iterate callback is defined as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_mpublic_8h.html#a689d878943fd9f1844809def5cfa60fe">H5M_iterate_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">void</span> *op_data);</div>
</div><!-- fragment --><p> The <code>key</code> parameter is the buffer for the key for this iteration, converted to the datatype specified by <code>key_mem_type_id</code>. The <code>op_data</code> parameter is a simple pass through of the value passed to <a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2" title="Iterates over all key-value pairs in a map object.">H5Miterate()</a>, which can be used to store application-defined data for iteration. A negative return value from this function will cause <a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2" title="Iterates over all key-value pairs in a map object.">H5Miterate()</a> to issue an error, while a positive return value will cause <a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2" title="Iterates over all key-value pairs in a map object.">H5Miterate()</a> to stop iterating and return this value without issuing an error. A return value of zero allows iteration to continue.</p>
<p>Any further options can be specified through the property list <code>dxpl_id</code>.</p>
<dl class="section warning"><dt>Warning</dt><dd>Adding or removing key-value pairs to the map during iteration will lead to undefined behavior.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga9318fe7ee18d5630ad831868675c7ce9" name="ga9318fe7ee18d5630ad831868675c7ce9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9318fe7ee18d5630ad831868675c7ce9">◆ </a></span>H5Miterate_by_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Miterate_by_name </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>map_name</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>idx</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>key_mem_type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_mpublic_8h.html#a689d878943fd9f1844809def5cfa60fe">H5M_iterate_t</a></td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>op_data</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>dxpl_id</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>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates over all key-value pairs in a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">map_name</td><td>Map object name relative to the location specified by <code>loc_id</code> </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Iteration index </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_mem_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>User-defined iterator function </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">op_data</td><td>User-defined callback function context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga9318fe7ee18d5630ad831868675c7ce9" title="Iterates over all key-value pairs in a map object.">H5Miterate_by_name()</a> iterates over all key-value pairs stored in the map object specified by <code>map_id</code>, making the callback specified by <code>op</code> for each. The <code>idx</code> parameter is an in/out parameter that may be used to restart a previously interrupted iteration. At the start of iteration <code>idx</code> should be set to 0, and to restart iteration at the same location on a subsequent call to <a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2" title="Iterates over all key-value pairs in a map object.">H5Miterate()</a>, <code>idx</code> should be the same value as returned by the previous call. Iterate callback is defined as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_mpublic_8h.html#a689d878943fd9f1844809def5cfa60fe">H5M_iterate_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> map_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">void</span> *op_data);</div>
</div><!-- fragment --><p> The<code>key</code> parameter is the buffer for the key for this iteration, converted to the datatype specified by <code>key_mem_type_id</code>. The <code>op_data</code> parameter is a simple pass through of the value passed to <a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2" title="Iterates over all key-value pairs in a map object.">H5Miterate()</a>, which can be used to store application-defined data for iteration. A negative return value from this function will cause <a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2" title="Iterates over all key-value pairs in a map object.">H5Miterate()</a> to issue an error, while a positive return value will cause <a class="el" href="#gaff5dc81a8a1150acee7e729a7747f1f2" title="Iterates over all key-value pairs in a map object.">H5Miterate()</a> to stop iterating and return this value without issuing an error. A return value of zero allows iteration to continue.</p>
<p>Any further options can be specified through the property list <code>dxpl_id</code>.</p>
<dl class="section warning"><dt>Warning</dt><dd>Adding or removing key-value pairs to the map during iteration will lead to undefined behavior.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga426fbeac4c90849f2ac1855447fb8d43" name="ga426fbeac4c90849f2ac1855447fb8d43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga426fbeac4c90849f2ac1855447fb8d43">◆ </a></span>H5Mopen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Mopen </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>name</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>mapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Map object name relative to <code>loc_id</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mapl_id</td><td>Map access property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a map object identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga426fbeac4c90849f2ac1855447fb8d43" title="Opens a map object.">H5Mopen()</a> finds a map object specified by <code>name</code> under the location specified by <code>loc_id</code>. The map object should be close with <a class="el" href="#gad9a6a1199edc0fb4a50d831a213a5f44" title="Terminates access to a map object.">H5Mclose()</a> when the application is not longer interested in accessing it.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga8cb388b30893cb79ed4d2bec4a8e8c4f" name="ga8cb388b30893cb79ed4d2bec4a8e8c4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8cb388b30893cb79ed4d2bec4a8e8c4f">◆ </a></span>H5Mput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Mput </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>map_id</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>key_mem_type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>key</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>val_mem_type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>value</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>dxpl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a key-value pair to a map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map_id</td><td>Map identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_mem_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>Pointer to key buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">val_mem_type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Pointer to value buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga8cb388b30893cb79ed4d2bec4a8e8c4f" title="Adds a key-value pair to a map object.">H5Mput()</a> adds a key-value pair to a map object specified by <code>map_id</code>, or updates the value for the specified key if one was set previously.</p>
<p><code>key_mem_type_id</code> and <code>val_mem_type_id</code> specify the datatypes for the provided key and value buffers, and if different from those used to create the map object, the key and value will be internally converted to the datatypes for the map object.</p>
<p>Any further options can be specified through the property list <code>dxpl_id</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.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>
|
