mirrors/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2026-09-25 04:09:44 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea9038e9f7cd7df6c71b8035cc765f268600a974
hdf5/develop/group___h5_d_s.html
T
byrnHDF ea9038e9f7 deploy: 780f6e40de
2026-09-02 01:23:41 +00:00

682 lines
48 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<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="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">
$(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.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>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Help us improve by taking our short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<!-- ... other metadata & script includes ... -->
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
<script type="text/javascript">
DoxygenAwesomeTabs.init()
</script>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-57FMZK4S7X"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-57FMZK4S7X');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign">
<div id="projectname">HDF5<span id="projectnumber">&#160;Last Updated on 2026-09-02</span>
</div>
<div id="projectbrief">The HDF5 Field Guide</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<div id="main-nav">
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="_getting_started.html"><span>Getting&#160;started</span></a></li>
<li><a href="_u_g.html"><span>User&#160;Guide</span></a></li>
<li><a href="_r_m.html"><span>Reference&#160;Manual</span></a></li>
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
<li><a href="_t_n.html"><span>Technical&#160;Notes</span></a></li>
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
<li><a href="_f_t_s.html"><span>Full-Text&#160;Search</span></a></li>
<li><a href="_about.html"><span>About</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></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()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- main-nav -->
</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">
$(function(){initNavTree('group___h5_d_s.html','',''); });
</script>
<div id="container">
<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="headertitle"><div class="title">HDF5 Dimension Scales APIs (H5DS) </div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><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 &quot;hdf5_hl.h&quot;</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="#gafd2a9719c14946b1478e3e79736b3094" title="H5DSwith_new_ref">H5DSwith_new_ref</a> <br />
Determines if new references are used with dimension scales.</li>
<li><a class="el" href="#ga0560840eeab7366cfe0c07cc6b57fe4b" title="H5DSattach_scale">H5DSattach_scale</a> <br />
Attach dimension scale dsid to dimension idx of dataset did.</li>
<li><a class="el" href="#gad4af4f5d5c880c5c93ca950cdf5a01fd" title="H5DSdetach_scale">H5DSdetach_scale</a> <br />
Detach dimension scale dsid from the dimension idx of Dataset did.</li>
<li><a class="el" href="#ga265aa3dadb5d067c112620ffe01f96d7" title="H5DSget_label">H5DSget_label</a> <br />
Read the label for dimension idx of did into buffer label.</li>
<li><a class="el" href="#ga562b91296f739a1833a1e1cfc64c7726" title="H5DSget_num_scales">H5DSget_num_scales</a> <br />
Determines how many Dimension Scales are attached to dimension idx of did.</li>
<li><a class="el" href="#ga704bbb7eb2c9696f0f2c84e0267e4ffa" title="H5DSget_scale_name">H5DSget_scale_name</a> <br />
Retrieves name of scale did into buffer name.</li>
<li><a class="el" href="#gad7bbd73a68b031f6ac4c305333b0c8b7" title="H5DSis_attached">H5DSis_attached</a> <br />
Report if dimension scale dsid is currently attached to dimension idx of dataset did.</li>
<li><a class="el" href="#gaf6c043d90b502ecf96783e8f50cadcd5" title="H5DSis_scale">H5DSis_scale</a> <br />
Determines whether dset is a Dimension Scale.</li>
<li><a class="el" href="#ga7cb78620d05e7dcb81a9f53a8cc496f5" title="H5DSiterate_scales">H5DSiterate_scales</a> <br />
Iterates the operation visitor through the scales attached to dimension dim.</li>
<li><a class="el" href="#ga10e953a37cf817f491fe47acb1370d88" title="H5DSset_label">H5DSset_label</a> <br />
Set label for the dimension idx of did to the value label.</li>
<li><a class="el" href="#gaca0f37c36c4e1288d161d26daa3a41d3" title="H5DSset_scale">H5DSset_scale</a> <br />
Convert dataset dsid to a dimension scale, with optional name, dimname. </li>
</ul>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0560840eeab7366cfe0c07cc6b57fe4b" id="r_ga0560840eeab7366cfe0c07cc6b57fe4b"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#ga0560840eeab7366cfe0c07cc6b57fe4b">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:ga0560840eeab7366cfe0c07cc6b57fe4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attach dimension scale <code class="param">dsid</code> to dimension <code class="param">idx</code> of dataset did. <br /></td></tr>
<tr class="memitem:gad4af4f5d5c880c5c93ca950cdf5a01fd" id="r_gad4af4f5d5c880c5c93ca950cdf5a01fd"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gad4af4f5d5c880c5c93ca950cdf5a01fd">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:gad4af4f5d5c880c5c93ca950cdf5a01fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detach dimension scale <code class="param">dsid</code> from the dimension <code class="param">idx</code> of dataset <code class="param">did</code>. <br /></td></tr>
<tr class="memitem:ga265aa3dadb5d067c112620ffe01f96d7" id="r_ga265aa3dadb5d067c112620ffe01f96d7"><td class="memItemLeft">H5HL_DLL ssize_t&#160;</td><td class="memItemRight"><a class="el" href="#ga265aa3dadb5d067c112620ffe01f96d7">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:ga265aa3dadb5d067c112620ffe01f96d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the label for dimension <code class="param">idx</code> of <code class="param">did</code> into buffer <code class="param">label</code>. <br /></td></tr>
<tr class="memitem:ga562b91296f739a1833a1e1cfc64c7726" id="r_ga562b91296f739a1833a1e1cfc64c7726"><td class="memItemLeft">H5HL_DLL int&#160;</td><td class="memItemRight"><a class="el" href="#ga562b91296f739a1833a1e1cfc64c7726">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:ga562b91296f739a1833a1e1cfc64c7726"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how many Dimension Scales are attached to dimension <code class="param">idx</code> of <code class="param">did</code>. <br /></td></tr>
<tr class="memitem:ga704bbb7eb2c9696f0f2c84e0267e4ffa" id="r_ga704bbb7eb2c9696f0f2c84e0267e4ffa"><td class="memItemLeft">H5HL_DLL ssize_t&#160;</td><td class="memItemRight"><a class="el" href="#ga704bbb7eb2c9696f0f2c84e0267e4ffa">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:ga704bbb7eb2c9696f0f2c84e0267e4ffa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves name of scale <code class="param">did</code> into buffer <code class="param">name</code>. <br /></td></tr>
<tr class="memitem:gad7bbd73a68b031f6ac4c305333b0c8b7" id="r_gad7bbd73a68b031f6ac4c305333b0c8b7"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gad7bbd73a68b031f6ac4c305333b0c8b7">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:gad7bbd73a68b031f6ac4c305333b0c8b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report if dimension scale <code class="param">dsid</code> is currently attached to dimension <code class="param">idx</code> of dataset <code class="param">did</code>. <br /></td></tr>
<tr class="memitem:gaf6c043d90b502ecf96783e8f50cadcd5" id="r_gaf6c043d90b502ecf96783e8f50cadcd5"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gaf6c043d90b502ecf96783e8f50cadcd5">H5DSis_scale</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> did)</td></tr>
<tr class="memdesc:gaf6c043d90b502ecf96783e8f50cadcd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines whether <code class="param">did</code> is a Dimension Scale. <br /></td></tr>
<tr class="memitem:ga7cb78620d05e7dcb81a9f53a8cc496f5" id="r_ga7cb78620d05e7dcb81a9f53a8cc496f5"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#ga7cb78620d05e7dcb81a9f53a8cc496f5">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:ga7cb78620d05e7dcb81a9f53a8cc496f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterates the operation visitor through the scales attached to dimension <code class="param">dim</code>. <br /></td></tr>
<tr class="memitem:ga10e953a37cf817f491fe47acb1370d88" id="r_ga10e953a37cf817f491fe47acb1370d88"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#ga10e953a37cf817f491fe47acb1370d88">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:ga10e953a37cf817f491fe47acb1370d88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set label for the dimension <code class="param">idx</code> of <code class="param">did</code> to the value <code class="param">label</code>. <br /></td></tr>
<tr class="memitem:gaca0f37c36c4e1288d161d26daa3a41d3" id="r_gaca0f37c36c4e1288d161d26daa3a41d3"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gaca0f37c36c4e1288d161d26daa3a41d3">H5DSset_scale</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dsid, const char *dimname)</td></tr>
<tr class="memdesc:gaca0f37c36c4e1288d161d26daa3a41d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert dataset <code class="param">dsid</code> to a dimension scale, with optional name, <code class="param">dimname</code>. <br /></td></tr>
<tr class="memitem:gafd2a9719c14946b1478e3e79736b3094" id="r_gafd2a9719c14946b1478e3e79736b3094"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gafd2a9719c14946b1478e3e79736b3094">H5DSwith_new_ref</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, bool *with_new_ref)</td></tr>
<tr class="memdesc:gafd2a9719c14946b1478e3e79736b3094"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if new references are used with dimension scales. <br /></td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="ga0560840eeab7366cfe0c07cc6b57fe4b" name="ga0560840eeab7366cfe0c07cc6b57fe4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0560840eeab7366cfe0c07cc6b57fe4b">&#9670;&#160;</a></span>H5DSattach_scale()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Attach dimension scale <code class="param">dsid</code> to dimension <code class="param">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 class="param">did</code> that <code class="param">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 class="param">dsid</code> to be associated with dimension <code class="param">idx</code> of dataset <code class="param">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 <a class="el" href="_h5_d_s__u_g.html#subsec_dim_scales_spec_store" title="Storage Profile">Storage Profile</a> section of the <a class="el" href="_h5_d_s__u_g.html" title="HDF5 High Level Dimension Scales">HDF5 High Level Dimension Scales</a>.</p>
<p>Fails if:</p><ul>
<li>Bad arguments</li>
<li>If <code class="param">dsid</code> is not a Dimension Scale</li>
<li>If <code class="param">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 class="param">dsid</code> can be attached to the same dimension more than once, which has no effect. </dd></dl>
</div>
</div>
<a id="gad4af4f5d5c880c5c93ca950cdf5a01fd" name="gad4af4f5d5c880c5c93ca950cdf5a01fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad4af4f5d5c880c5c93ca950cdf5a01fd">&#9670;&#160;</a></span>H5DSdetach_scale()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Detach dimension scale <code class="param">dsid</code> from the dimension <code class="param">idx</code> of dataset <code class="param">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 class="param">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 class="param">dsid</code> with dimension <code class="param">idx</code> of dataset <code class="param">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 <a class="el" href="_h5_d_s__u_g.html#subsec_dim_scales_spec_store" title="Storage Profile">Storage Profile</a> section of the <a class="el" href="_h5_d_s__u_g.html" title="HDF5 High Level Dimension Scales">HDF5 High Level Dimension Scales</a>.</p>
<p>Fails if:</p><ul>
<li>Bad arguments</li>
<li>The dataset <code class="param">did</code> or <code class="param">dsid</code> do not exist</li>
<li>The <code class="param">dsid</code> is not a Dimension Scale</li>
<li><code class="param">dsid</code> is not attached to <code class="param">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 class="param">did</code>. </dd></dl>
</div>
</div>
<a id="ga265aa3dadb5d067c112620ffe01f96d7" name="ga265aa3dadb5d067c112620ffe01f96d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga265aa3dadb5d067c112620ffe01f96d7">&#9670;&#160;</a></span>H5DSget_label()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL ssize_t 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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the label for dimension <code class="param">idx</code> of <code class="param">did</code> into buffer <code class="param">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 class="param">idx</code> of dataset <code class="param">did</code>, if set. Up to <code class="param">size</code> characters of the name are copied into the buffer <code class="param">label</code>. If the label is longer than <code class="param">size</code>, it will be truncated to fit. The parameter <code class="param">size</code> is set to the size of the returned <code class="param">label</code>.</p>
<p>If <code class="param">did</code> has no label, the return value of <code class="param">label</code> is NULL.</p>
<p>Fails if:</p><ul>
<li>Bad arguments </li>
</ul>
</div>
</div>
<a id="ga562b91296f739a1833a1e1cfc64c7726" name="ga562b91296f739a1833a1e1cfc64c7726"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga562b91296f739a1833a1e1cfc64c7726">&#9670;&#160;</a></span>H5DSget_num_scales()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL 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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines how many Dimension Scales are attached to dimension <code class="param">idx</code> of <code class="param">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 class="param">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 class="param">did</code>, if successful, otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#ga562b91296f739a1833a1e1cfc64c7726" 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 class="param">idx</code> of dataset <code class="param">did</code>. </p>
</div>
</div>
<a id="ga704bbb7eb2c9696f0f2c84e0267e4ffa" name="ga704bbb7eb2c9696f0f2c84e0267e4ffa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga704bbb7eb2c9696f0f2c84e0267e4ffa">&#9670;&#160;</a></span>H5DSget_scale_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL ssize_t 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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves name of scale <code class="param">did</code> into buffer <code class="param">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 class="param">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="#ga704bbb7eb2c9696f0f2c84e0267e4ffa" title="Retrieves name of scale did into buffer name.">H5DSget_scale_name()</a> retrieves the name attribute for scale <code class="param">did</code>.</p>
<p>Up to <code class="param">size</code> characters of the scale name are returned in <code class="param">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 class="param">size</code>, is unknown, a preliminary <a class="el" href="#ga704bbb7eb2c9696f0f2c84e0267e4ffa" title="Retrieves name of scale did into buffer name.">H5DSget_scale_name()</a> call can be made by setting <code class="param">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 class="param">size</code> for a second <a class="el" href="#ga704bbb7eb2c9696f0f2c84e0267e4ffa" 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 class="param">size</code> must be one greater than size in bytes of the actual name in order to accommodate the null terminator; if <code class="param">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="gad7bbd73a68b031f6ac4c305333b0c8b7" name="gad7bbd73a68b031f6ac4c305333b0c8b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad7bbd73a68b031f6ac4c305333b0c8b7">&#9670;&#160;</a></span>H5DSis_attached()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report if dimension scale <code class="param">dsid</code> is currently attached to dimension <code class="param">idx</code> of dataset <code class="param">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 class="param">did</code> that <code class="param">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 class="param">dsid</code> is currently attached to dimension <code class="param">idx</code> of dataset <code class="param">did</code>.</p>
<p>Fails if:</p><ul>
<li>Bad arguments</li>
<li>If <code class="param">dsid</code> is not a Dimension Scale</li>
<li>The <code class="param">dsid</code> is not a Dimension Scale</li>
<li>If <code class="param">did</code> is a Dimension Scale (A Dimension Scale cannot have scales.) </li>
</ul>
</div>
</div>
<a id="gaf6c043d90b502ecf96783e8f50cadcd5" name="gaf6c043d90b502ecf96783e8f50cadcd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf6c043d90b502ecf96783e8f50cadcd5">&#9670;&#160;</a></span>H5DSis_scale()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <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 class="param">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="#gaf6c043d90b502ecf96783e8f50cadcd5" title="Determines whether did is a Dimension Scale.">H5DSis_scale()</a> determines if <code class="param">did</code> is a Dimension Scale, i.e., has class="DIMENSION_SCALE"). </p>
</div>
</div>
<a id="ga7cb78620d05e7dcb81a9f53a8cc496f5" name="ga7cb78620d05e7dcb81a9f53a8cc496f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7cb78620d05e7dcb81a9f53a8cc496f5">&#9670;&#160;</a></span>H5DSiterate_scales()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates the operation visitor through the scales attached to dimension <code class="param">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 class="param">did</code> </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td><a class="el" href="struct_input.html">Input</a> 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="#ga7cb78620d05e7dcb81a9f53a8cc496f5" title="Iterates the operation visitor through the scales attached to dimension dim.">H5DSiterate_scales()</a> iterates over the scales attached to dimension <code class="param">dim</code> of dataset <code class="param">did</code>. For each scale in the list, the <code class="param">visitor_data</code> and some additional information, specified below, are passed to the <code class="param">visitor</code> function. The iteration begins with the <code class="param">idx</code> object in the group and the next element to be processed by the operator is returned in <code class="param">idx</code>. If <code class="param">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" title="H5DS_iterate_t">H5DS_iterate_t</a> is: </p><div class="fragment"><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_d_spublic_8h.html#a7979d0cd5a423ae1cbccd0b65600bdf6">H5DS_iterate_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dset, <span class="keywordtype">unsigned</span> dim, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> scale, <span class="keywordtype">void</span> *visitor_data);</div>
</div><!-- fragment --><p>The operation receives the Dimension Scale dataset identifier, <code class="param">scale</code>, and the pointer to the operator data passed in to <a class="el" href="#ga7cb78620d05e7dcb81a9f53a8cc496f5" title="Iterates the operation visitor through the scales attached to dimension dim.">H5DSiterate_scales()</a>, <code class="param">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="#ga7cb78620d05e7dcb81a9f53a8cc496f5" 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 class="param">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="ga10e953a37cf817f491fe47acb1370d88" name="ga10e953a37cf817f491fe47acb1370d88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga10e953a37cf817f491fe47acb1370d88">&#9670;&#160;</a></span>H5DSset_label()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set label for the dimension <code class="param">idx</code> of <code class="param">did</code> to the value <code class="param">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 class="param">idx</code> of dataset <code class="param">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="gaca0f37c36c4e1288d161d26daa3a41d3" name="gaca0f37c36c4e1288d161d26daa3a41d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaca0f37c36c4e1288d161d26daa3a41d3">&#9670;&#160;</a></span>H5DSset_scale()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert dataset <code class="param">dsid</code> to a dimension scale, with optional name, <code class="param">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 class="param">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 class="el" href="_h5_d_s__u_g.html#subsec_dim_scales_spec_store" title="Storage Profile">Storage Profile</a> section of the <a class="el" href="_h5_d_s__u_g.html" title="HDF5 High Level Dimension Scales">HDF5 High Level Dimension Scales</a>.</p>
<p>If <code class="param">dimname</code> is specified, then an attribute called NAME is created, with the value <code class="param">dimname</code>.</p>
<p>Fails if:</p><ul>
<li>Bad arguments</li>
<li>If <code class="param">dsid</code> is already a scale</li>
<li>If <code class="param">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#_todo000003">Todo</a></b></dt><dd>what is [9] after Palette interface? </dd></dl>
</div>
</div>
<a id="gafd2a9719c14946b1478e3e79736b3094" name="gafd2a9719c14946b1478e3e79736b3094"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafd2a9719c14946b1478e3e79736b3094">&#9670;&#160;</a></span>H5DSwith_new_ref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <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">bool *</td> <td class="paramname"><span class="paramname"><em>with_new_ref</em></span>&#160;)</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="#gafd2a9719c14946b1478e3e79736b3094" 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 -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink