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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: HDF5 Dimension Scales APIs (H5DS)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.2908dd1</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('group___h5_d_s.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">HDF5 Dimension Scales APIs (H5DS)</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><em>Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset (H5DS)</em></p>
<dl class="section note"><dt>Note</dt><dd><b>Programming hints:</b> </dd>
<dd>
To use any of these functions or subroutines, you must first include the relevant include file (C) or module (Fortran) in your application. </dd>
<dd>
The following line includes the HDF5 Dimension Scale package, H5DS, in C applications: <div class="fragment"><div class="line"><span class="preprocessor">#include "hdf5_hl.h"</span> </div>
</div><!-- fragment --> </dd>
<dd>
This line includes the H5DS module in Fortran applications: <div class="fragment"><div class="line">use <a class="code hl_namespace" href="namespaceh5ds.html">h5ds</a> </div>
<div class="ttc" id="anamespaceh5ds_html"><div class="ttname"><a href="namespaceh5ds.html">h5ds</a></div><div class="ttdoc">This module contains Fortran interfaces for H5DS.</div><div class="ttdef"><b>Definition</b> H5DSff.F90:35</div></div>
</div><!-- fragment --></dd></dl>
<ul>
<li><a class="el" href="#gaed2b97139202dfe69f3f2a7364c10fbc">H5DSwith_new_ref</a> <br />
Determines if new references are used with dimension scales.</li>
<li><a class="el" href="#ga4149785cd62520d6fc2736489f74e296">H5DSattach_scale</a> <br />
Attach dimension scale dsid to dimension idx of dataset did.</li>
<li><a class="el" href="#gac94c498a5f8fc38b0619307f2ac1593a">H5DSdetach_scale</a> <br />
Detach dimension scale dsid from the dimension idx of Dataset did.</li>
<li><a class="el" href="#gaaefa5dcd96a7dba034764b70e2f3aa38">H5DSget_label</a> <br />
Read the label for dimension idx of did into buffer label.</li>
<li><a class="el" href="#gaa373f8cb78fa2014c50fe8e3dd85ea90">H5DSget_num_scales</a> <br />
Determines how many Dimension Scales are attached to dimension idx of did.</li>
<li><a class="el" href="#ga81de6ce31478c7bc3a9f80b8c600170a">H5DSget_scale_name</a> <br />
Retrieves name of scale did into buffer name.</li>
<li><a class="el" href="#ga76884eddb41d52adf4eb3278c135bbe4">H5DSis_attached</a> <br />
Report if dimension scale dsid is currently attached to dimension idx of dataset did.</li>
<li><a class="el" href="#ga06f897270fe32408f40bba69c747fc6b">H5DSis_scale</a> <br />
Determines whether dset is a Dimension Scale.</li>
<li><a class="el" href="#ga5394de7b3d915f45881abeb158060274">H5DSiterate_scales</a> <br />
Iterates the operation visitor through the scales attached to dimension dim.</li>
<li><a class="el" href="#gaf3810cf2fde9e8d06d8151a879e081b2">H5DSset_label</a> <br />
Set label for the dimension idx of did to the value label.</li>
<li><a class="el" href="#ga508a06962e9fc11dff32ed356e0a71fa">H5DSset_scale</a> <br />
Convert dataset dsid to a dimension scale, with optional name, dimname. </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:gaed2b97139202dfe69f3f2a7364c10fbc" id="r_gaed2b97139202dfe69f3f2a7364c10fbc"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaed2b97139202dfe69f3f2a7364c10fbc">H5DSwith_new_ref</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *with_new_ref)</td></tr>
<tr class="memdesc:gaed2b97139202dfe69f3f2a7364c10fbc"><td class="mdescLeft"> </td><td class="mdescRight">Determines if new references are used with dimension scales. <br /></td></tr>
<tr class="separator:gaed2b97139202dfe69f3f2a7364c10fbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4149785cd62520d6fc2736489f74e296" id="r_ga4149785cd62520d6fc2736489f74e296"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4149785cd62520d6fc2736489f74e296">H5DSattach_scale</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dsid, unsigned int idx)</td></tr>
<tr class="memdesc:ga4149785cd62520d6fc2736489f74e296"><td class="mdescLeft"> </td><td class="mdescRight">Attach dimension scale <code>dsid</code> to dimension <code>idx</code> of dataset did. <br /></td></tr>
<tr class="separator:ga4149785cd62520d6fc2736489f74e296"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac94c498a5f8fc38b0619307f2ac1593a" id="r_gac94c498a5f8fc38b0619307f2ac1593a"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac94c498a5f8fc38b0619307f2ac1593a">H5DSdetach_scale</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dsid, unsigned int idx)</td></tr>
<tr class="memdesc:gac94c498a5f8fc38b0619307f2ac1593a"><td class="mdescLeft"> </td><td class="mdescRight">Detach dimension scale <code>dsid</code> from the dimension <code>idx</code> of dataset <code>did</code>. <br /></td></tr>
<tr class="separator:gac94c498a5f8fc38b0619307f2ac1593a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga508a06962e9fc11dff32ed356e0a71fa" id="r_ga508a06962e9fc11dff32ed356e0a71fa"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga508a06962e9fc11dff32ed356e0a71fa">H5DSset_scale</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dsid, const char *dimname)</td></tr>
<tr class="memdesc:ga508a06962e9fc11dff32ed356e0a71fa"><td class="mdescLeft"> </td><td class="mdescRight">Convert dataset <code>dsid</code> to a dimension scale, with optional name, <code>dimname</code>. <br /></td></tr>
<tr class="separator:ga508a06962e9fc11dff32ed356e0a71fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa373f8cb78fa2014c50fe8e3dd85ea90" id="r_gaa373f8cb78fa2014c50fe8e3dd85ea90"><td class="memItemLeft" align="right" valign="top">H5_HLDLL int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa373f8cb78fa2014c50fe8e3dd85ea90">H5DSget_num_scales</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did, unsigned int idx)</td></tr>
<tr class="memdesc:gaa373f8cb78fa2014c50fe8e3dd85ea90"><td class="mdescLeft"> </td><td class="mdescRight">Determines how many Dimension Scales are attached to dimension <code>idx</code> of <code>did</code>. <br /></td></tr>
<tr class="separator:gaa373f8cb78fa2014c50fe8e3dd85ea90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf3810cf2fde9e8d06d8151a879e081b2" id="r_gaf3810cf2fde9e8d06d8151a879e081b2"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf3810cf2fde9e8d06d8151a879e081b2">H5DSset_label</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did, unsigned int idx, const char *label)</td></tr>
<tr class="memdesc:gaf3810cf2fde9e8d06d8151a879e081b2"><td class="mdescLeft"> </td><td class="mdescRight">Set label for the dimension <code>idx</code> of <code>did</code> to the value <code>label</code>. <br /></td></tr>
<tr class="separator:gaf3810cf2fde9e8d06d8151a879e081b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaefa5dcd96a7dba034764b70e2f3aa38" id="r_gaaefa5dcd96a7dba034764b70e2f3aa38"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaaefa5dcd96a7dba034764b70e2f3aa38">H5DSget_label</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did, unsigned int idx, char *label, size_t size)</td></tr>
<tr class="memdesc:gaaefa5dcd96a7dba034764b70e2f3aa38"><td class="mdescLeft"> </td><td class="mdescRight">Read the label for dimension <code>idx</code> of <code>did</code> into buffer <code>label</code>. <br /></td></tr>
<tr class="separator:gaaefa5dcd96a7dba034764b70e2f3aa38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga81de6ce31478c7bc3a9f80b8c600170a" id="r_ga81de6ce31478c7bc3a9f80b8c600170a"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga81de6ce31478c7bc3a9f80b8c600170a">H5DSget_scale_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did, char *name, size_t size)</td></tr>
<tr class="memdesc:ga81de6ce31478c7bc3a9f80b8c600170a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves name of scale <code>did</code> into buffer <code>name</code>. <br /></td></tr>
<tr class="separator:ga81de6ce31478c7bc3a9f80b8c600170a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga06f897270fe32408f40bba69c747fc6b" id="r_ga06f897270fe32408f40bba69c747fc6b"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga06f897270fe32408f40bba69c747fc6b">H5DSis_scale</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did)</td></tr>
<tr class="memdesc:ga06f897270fe32408f40bba69c747fc6b"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether <code>did</code> is a Dimension Scale. <br /></td></tr>
<tr class="separator:ga06f897270fe32408f40bba69c747fc6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5394de7b3d915f45881abeb158060274" id="r_ga5394de7b3d915f45881abeb158060274"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5394de7b3d915f45881abeb158060274">H5DSiterate_scales</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did, unsigned int dim, int *idx, <a class="el" href="_h5_d_spublic_8h.html#a7979d0cd5a423ae1cbccd0b65600bdf6">H5DS_iterate_t</a> visitor, void *visitor_data)</td></tr>
<tr class="memdesc:ga5394de7b3d915f45881abeb158060274"><td class="mdescLeft"> </td><td class="mdescRight">Iterates the operation visitor through the scales attached to dimension <code>dim</code>. <br /></td></tr>
<tr class="separator:ga5394de7b3d915f45881abeb158060274"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga76884eddb41d52adf4eb3278c135bbe4" id="r_ga76884eddb41d52adf4eb3278c135bbe4"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga76884eddb41d52adf4eb3278c135bbe4">H5DSis_attached</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dsid, unsigned int idx)</td></tr>
<tr class="memdesc:ga76884eddb41d52adf4eb3278c135bbe4"><td class="mdescLeft"> </td><td class="mdescRight">Report if dimension scale <code>dsid</code> is currently attached to dimension <code>idx</code> of dataset <code>did</code>. <br /></td></tr>
<tr class="separator:ga76884eddb41d52adf4eb3278c135bbe4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga4149785cd62520d6fc2736489f74e296" name="ga4149785cd62520d6fc2736489f74e296"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4149785cd62520d6fc2736489f74e296">◆ </a></span>H5DSattach_scale()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5DSattach_scale </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>did</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>dsid</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>idx</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Attach dimension scale <code>dsid</code> to dimension <code>idx</code> of dataset did. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">did</td><td>The dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dsid</td><td>The scale to be attached </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>The dimension of <code>did</code> that <code>dsid</code> is associated with</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>Define Dimension Scale <code>dsid</code> to be associated with dimension <code>idx</code> of dataset <code>did</code>.</p>
<p>Entries are created in the <a class="el" href="_h5_d_spublic_8h.html#a3c3e0049491003d0fb4f085bb8f504db">DIMENSION_LIST</a> and <a class="el" href="_h5_d_spublic_8h.html#a16370c2d086f86916320c34e416cf445">REFERENCE_LIST</a> attributes, as defined in section 4.2 of <a href="https://support.hdfgroup.org/HDF5/doc/HL/H5DS_Spec.pdf">HDF5 Dimension Scale Specification</a>.</p>
<p>Fails if:</p><ul>
<li>Bad arguments</li>
<li>If <code>dsid</code> is not a Dimension Scale</li>
<li>If <code>did</code> is a Dimension Scale (A Dimension Scale cannot have scales.)</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>The Dimension Scale <code>dsid</code> can be attached to the same dimension more than once, which has no effect. </dd></dl>
</div>
</div>
<a id="gac94c498a5f8fc38b0619307f2ac1593a" name="gac94c498a5f8fc38b0619307f2ac1593a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac94c498a5f8fc38b0619307f2ac1593a">◆ </a></span>H5DSdetach_scale()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5DSdetach_scale </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>did</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>dsid</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>idx</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Detach dimension scale <code>dsid</code> from the dimension <code>idx</code> of dataset <code>did</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">did</td><td>The dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dsid</td><td>The scale to be detached </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>The dimension of <code>did</code> to detach</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>If possible, deletes association of Dimension Scale <code>dsid</code> with dimension <code>idx</code> of dataset <code>did</code>. This deletes the entries in the <a class="el" href="_h5_d_spublic_8h.html#a3c3e0049491003d0fb4f085bb8f504db">DIMENSION_LIST</a> and <a class="el" href="_h5_d_spublic_8h.html#a16370c2d086f86916320c34e416cf445">REFERENCE_LIST</a> attributes, as defined in section 4.2 of <a href="https://support.hdfgroup.org/HDF5/doc/HL/H5DS_Spec.pdf">HDF5 Dimension Scale Specification</a>.</p>
<p>Fails if:</p><ul>
<li>Bad arguments</li>
<li>The dataset <code>did</code> or <code>dsid</code> do not exist</li>
<li>The <code>dsid</code> is not a Dimension Scale</li>
<li><code>dsid</code> is not attached to <code>did</code> </li>
</ul>
<dl class="section note"><dt>Note</dt><dd>A scale may be associated with more than dimension of the same dataset. If so, the detach operation only deletes one of the associations, for <code>did</code>. </dd></dl>
</div>
</div>
<a id="gaaefa5dcd96a7dba034764b70e2f3aa38" name="gaaefa5dcd96a7dba034764b70e2f3aa38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaefa5dcd96a7dba034764b70e2f3aa38">◆ </a></span>H5DSget_label()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5DSget_label </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>did</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>idx</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>label</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the label for dimension <code>idx</code> of <code>did</code> into buffer <code>label</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">did</td><td>The dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>The dimension </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">label</td><td>The label </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The length of the label buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Upon success, size of label or zero if no label found. Negative if fail.</dd></dl>
<p>Returns the value of the <a class="el" href="_h5_d_spublic_8h.html#a2938efb8ad35991157e48a19900eae61">DIMENSION_LABELS</a> for dimension <code>idx</code> of dataset <code>did</code>, if set. Up to <code>size</code> characters of the name are copied into the buffer <code>label</code>. If the label is longer than <code>size</code>, it will be truncated to fit. The parameter <code>size</code> is set to the size of the returned <code>label</code>.</p>
<p>If <code>did</code> has no label, the return value of <code>label</code> is NULL.</p>
<p>Fails if:</p><ul>
<li>Bad arguments </li>
</ul>
</div>
</div>
<a id="gaa373f8cb78fa2014c50fe8e3dd85ea90" name="gaa373f8cb78fa2014c50fe8e3dd85ea90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa373f8cb78fa2014c50fe8e3dd85ea90">◆ </a></span>H5DSget_num_scales()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL int H5DSget_num_scales </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>did</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>idx</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines how many Dimension Scales are attached to dimension <code>idx</code> of <code>did</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">did</td><td>The dataset to query </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>The dimension of <code>did</code> to query</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of Dimension Scales associated with <code>did</code>, if successful, otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#gaa373f8cb78fa2014c50fe8e3dd85ea90" title="Determines how many Dimension Scales are attached to dimension idx of did.">H5DSget_num_scales()</a> determines how many Dimension Scales are attached to dimension <code>idx</code> of dataset <code>did</code>. </p>
</div>
</div>
<a id="ga81de6ce31478c7bc3a9f80b8c600170a" name="ga81de6ce31478c7bc3a9f80b8c600170a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga81de6ce31478c7bc3a9f80b8c600170a">◆ </a></span>H5DSget_scale_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5DSget_scale_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>did</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves name of scale <code>did</code> into buffer <code>name</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">did</td><td>Dimension scale identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Buffer to contain the returned name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size in bytes, of the <code>name</code> buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Upon success, the length of the scale name or zero if no name found. Negative if fail.</dd></dl>
<p><a class="el" href="#ga81de6ce31478c7bc3a9f80b8c600170a" title="Retrieves name of scale did into buffer name.">H5DSget_scale_name()</a> retrieves the name attribute for scale <code>did</code>.</p>
<p>Up to <code>size</code> characters of the scale name are returned in <code>name</code>; additional characters, if any, are not returned to the user application.</p>
<p>If the length of the name, which determines the required value of <code>size</code>, is unknown, a preliminary <a class="el" href="#ga81de6ce31478c7bc3a9f80b8c600170a" title="Retrieves name of scale did into buffer name.">H5DSget_scale_name()</a> call can be made by setting <code>name</code> to NULL. The return value of this call will be the size of the scale name; that value plus one (1) can then be assigned to <code>size</code> for a second <a class="el" href="#ga81de6ce31478c7bc3a9f80b8c600170a" title="Retrieves name of scale did into buffer name.">H5DSget_scale_name()</a> call, which will retrieve the actual name. (The value passed in with the parameter <code>size</code> must be one greater than size in bytes of the actual name in order to accommodate the null terminator; if <code>size</code> is set to the exact size of the name, the last byte passed back will contain the null terminator and the last character will be missing from the name passed back to the calling application.) </p>
</div>
</div>
<a id="ga76884eddb41d52adf4eb3278c135bbe4" name="ga76884eddb41d52adf4eb3278c135bbe4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga76884eddb41d52adf4eb3278c135bbe4">◆ </a></span>H5DSis_attached()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5DSis_attached </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>did</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>dsid</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>idx</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report if dimension scale <code>dsid</code> is currently attached to dimension <code>idx</code> of dataset <code>did</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">did</td><td>The dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dsid</td><td>The scale to be attached </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>The dimension of <code>did</code> that <code>dsid</code> is associated with</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
<p>Report if dimension scale <code>dsid</code> is currently attached to dimension <code>idx</code> of dataset <code>did</code>.</p>
<p>Fails if:</p><ul>
<li>Bad arguments</li>
<li>If <code>dsid</code> is not a Dimension Scale</li>
<li>The <code>dsid</code> is not a Dimension Scale</li>
<li>If <code>did</code> is a Dimension Scale (A Dimension Scale cannot have scales.) </li>
</ul>
</div>
</div>
<a id="ga06f897270fe32408f40bba69c747fc6b" name="ga06f897270fe32408f40bba69c747fc6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga06f897270fe32408f40bba69c747fc6b">◆ </a></span>H5DSis_scale()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5DSis_scale </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>did</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether <code>did</code> is a Dimension Scale. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">did</td><td>The dataset to query</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
<p><a class="el" href="#ga06f897270fe32408f40bba69c747fc6b" title="Determines whether did is a Dimension Scale.">H5DSis_scale()</a> determines if <code>did</code> is a Dimension Scale, i.e., has class="DIMENSION_SCALE"). </p>
</div>
</div>
<a id="ga5394de7b3d915f45881abeb158060274" name="ga5394de7b3d915f45881abeb158060274"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5394de7b3d915f45881abeb158060274">◆ </a></span>H5DSiterate_scales()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5DSiterate_scales </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>did</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>dim</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *</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_d_spublic_8h.html#a7979d0cd5a423ae1cbccd0b65600bdf6">H5DS_iterate_t</a></td> <td class="paramname"><span class="paramname"><em>visitor</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>visitor_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates the operation visitor through the scales attached to dimension <code>dim</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">did</td><td>The dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dim</td><td>The dimension of dataset <code>did</code> </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Input the index to start iterating, output the next index to visit. If NULL, start at the first position. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">visitor</td><td>The visitor function </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">visitor_data</td><td>Arbitrary data to pass to the visitor function</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the return value of the last operator if it was non-zero, or zero if all scales were processed.</dd></dl>
<p><a class="el" href="#ga5394de7b3d915f45881abeb158060274" title="Iterates the operation visitor through the scales attached to dimension dim.">H5DSiterate_scales()</a> iterates over the scales attached to dimension <code>dim</code> of dataset <code>did</code>. For each scale in the list, the <code>visitor_data</code> and some additional information, specified below, are passed to the <code>visitor</code> function. The iteration begins with the <code>idx</code> object in the group and the next element to be processed by the operator is returned in <code>idx</code>. If <code>idx</code> is NULL, then the iterator starts at the first group member; since no stopping point is returned in this case, the iterator cannot be restarted if one of the calls to its operator returns non-zero.</p>
<p>The prototype for <a class="el" href="_h5_d_spublic_8h.html#a7979d0cd5a423ae1cbccd0b65600bdf6">H5DS_iterate_t</a> is: </p><div class="fragment"></div><!-- fragment --><p>The operation receives the Dimension Scale dataset identifier, <code>scale</code>, and the pointer to the operator data passed in to <a class="el" href="#ga5394de7b3d915f45881abeb158060274" title="Iterates the operation visitor through the scales attached to dimension dim.">H5DSiterate_scales()</a>, <code>visitor_data</code>.</p>
<p>The return values from an operator are:</p>
<ul>
<li>Zero causes the iterator to continue, returning zero when all group members have been processed.</li>
<li>Positive causes the iterator to immediately return that positive value, indicating short-circuit success. The iterator can be restarted at the next group member.</li>
<li>Negative causes the iterator to immediately return that value, indicating failure. The iterator can be restarted at the next group member.</li>
</ul>
<p><a class="el" href="#ga5394de7b3d915f45881abeb158060274" title="Iterates the operation visitor through the scales attached to dimension dim.">H5DSiterate_scales()</a> assumes that the scales of the dimension identified by <code>dim</code> remain unchanged through the iteration. If the membership changes during the iteration, the function's behavior is undefined. </p>
</div>
</div>
<a id="gaf3810cf2fde9e8d06d8151a879e081b2" name="gaf3810cf2fde9e8d06d8151a879e081b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf3810cf2fde9e8d06d8151a879e081b2">◆ </a></span>H5DSset_label()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5DSset_label </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>did</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>idx</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>label</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set label for the dimension <code>idx</code> of <code>did</code> to the value <code>label</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">did</td><td>The dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>The dimension </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">label</td><td>The label</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>Sets the <a class="el" href="_h5_d_spublic_8h.html#a2938efb8ad35991157e48a19900eae61">DIMENSION_LABELS</a> for dimension <code>idx</code> of dataset <code>did</code>. If the dimension had a label, the new value replaces the old.</p>
<p>Fails if:</p><ul>
<li>Bad arguments </li>
</ul>
</div>
</div>
<a id="ga508a06962e9fc11dff32ed356e0a71fa" name="ga508a06962e9fc11dff32ed356e0a71fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga508a06962e9fc11dff32ed356e0a71fa">◆ </a></span>H5DSset_scale()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5DSset_scale </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>dsid</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dimname</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert dataset <code>dsid</code> to a dimension scale, with optional name, <code>dimname</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dsid</td><td>The dataset to be made a Dimemsion Scale </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dimname</td><td>The dimension name (optional), NULL if the dimension has no name.</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>The dataset <code>dsid</code> is converted to a Dimension Scale dataset, as defined above. Creates the CLASS attribute, set to the value "DIMENSION_SCALE" and an empty <a class="el" href="_h5_d_spublic_8h.html#a16370c2d086f86916320c34e416cf445">REFERENCE_LIST</a> attribute, as described in <a href="https://support.hdfgroup.org/HDF5/doc/HL/H5DS_Spec.pdf">HDF5 Dimension Scale Specification</a>. (PDF, see section 4.2).</p>
<p>If <code>dimname</code> is specified, then an attribute called NAME is created, with the value <code>dimname</code>.</p>
<p>Fails if:</p><ul>
<li>Bad arguments</li>
<li>If <code>dsid</code> is already a scale</li>
<li>If <code>dsid</code> is a dataset which already has dimension scales</li>
</ul>
<p>If the dataset was created with the Table, Image, or Palette interface [9], it is not recommended to convert to a Dimension Scale. (These Datasets will have a CLASS Table, Image, or Palette.)</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo</a></b></dt><dd>what is [9] after Palette interface? </dd></dl>
</div>
</div>
<a id="gaed2b97139202dfe69f3f2a7364c10fbc" name="gaed2b97139202dfe69f3f2a7364c10fbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaed2b97139202dfe69f3f2a7364c10fbc">◆ </a></span>H5DSwith_new_ref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5DSwith_new_ref </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="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *</td> <td class="paramname"><span class="paramname"><em>with_new_ref</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if new references are used with dimension scales. </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>Object identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">with_new_ref</td><td>New references are used or not</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="#gaed2b97139202dfe69f3f2a7364c10fbc" title="Determines if new references are used with dimension scales.">H5DSwith_new_ref()</a> takes any object identifier and checks if new references are used for dimension scales. Currently, new references are used when non-native VOL connector is used or when H5_DIMENSION_SCALES_WITH_NEW_REF is set up via configure option. </p>
</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>
|
