mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-28 04:09:38 +03:00
2192 lines
168 KiB
HTML
2192 lines
168 KiB
HTML
<!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.9.7"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>HDF5: Attributes (H5A)</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript">var page_layout=1;</script>
|
|
<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>
|
|
<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 */
|
|
$(document).ready(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="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">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>
|
|
</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"> 1.15.0.405d1b9</span>
|
|
</div>
|
|
<div id="projectbrief">API Reference</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.7 -->
|
|
<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 id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="_getting_started.html"><span>Getting started</span></a></li>
|
|
<li><a href="_u_g.html"><span>User Guide</span></a></li>
|
|
<li><a href="_r_m.html"><span>Reference Manual</span></a></li>
|
|
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
|
|
<li><a href="_t_n.html"><span>Technical 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="_about.html"><span>About</span></a></li>
|
|
<li>
|
|
<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>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</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 */
|
|
$(document).ready(function(){initNavTree('group___h5_a.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="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Attributes (H5A)</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>An HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. A primary data object may be a dataset, group, or committed datatype.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="_h5_a__u_g.html#sec_attribute">HDF5 Attributes</a> </dd></dl>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga4a76e4e5ab6eb0fd2aa7990d38d55f24"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga4a76e4e5ab6eb0fd2aa7990d38d55f24">H5Acreate</a>   <a class="el" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308">H5Acreate2</a></td></tr>
|
|
<tr class="separator:ga4a76e4e5ab6eb0fd2aa7990d38d55f24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab9dcfc543cd4282f32b8ea19e08ffa6c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gab9dcfc543cd4282f32b8ea19e08ffa6c">H5Aiterate</a>   <a class="el" href="group___h5_a.html#ga9315a22b60468b6e996559b1b8a77251">H5Aiterate2</a></td></tr>
|
|
<tr class="separator:gab9dcfc543cd4282f32b8ea19e08ffa6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:gaef4394b661e2c930879e9868e122bdda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda">H5Aclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id)</td></tr>
|
|
<tr class="memdesc:gaef4394b661e2c930879e9868e122bdda"><td class="mdescLeft"> </td><td class="mdescRight">Closes the specified attribute. <br /></td></tr>
|
|
<tr class="separator:gaef4394b661e2c930879e9868e122bdda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4f4e5248c09f689633079ed8afc0b308"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308">H5Acreate2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *attr_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> acpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id)</td></tr>
|
|
<tr class="memdesc:ga4f4e5248c09f689633079ed8afc0b308"><td class="mdescLeft"> </td><td class="mdescRight">Creates an attribute attached to a specified object. <br /></td></tr>
|
|
<tr class="separator:ga4f4e5248c09f689633079ed8afc0b308"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga004160c28e281455ec48aa7fe557ef8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga004160c28e281455ec48aa7fe557ef8a">H5Acreate_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, const char *attr_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> acpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:ga004160c28e281455ec48aa7fe557ef8a"><td class="mdescLeft"> </td><td class="mdescRight">Creates an attribute attached to a specified object. <br /></td></tr>
|
|
<tr class="separator:ga004160c28e281455ec48aa7fe557ef8a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gada9fa3d6db52329f1fd55662de6ff6ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gada9fa3d6db52329f1fd55662de6ff6ba">H5Adelete</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *attr_name)</td></tr>
|
|
<tr class="memdesc:gada9fa3d6db52329f1fd55662de6ff6ba"><td class="mdescLeft"> </td><td class="mdescRight">Deletes an attribute from a specified location. <br /></td></tr>
|
|
<tr class="separator:gada9fa3d6db52329f1fd55662de6ff6ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga06711a4e77ff8ab49e427010fd38ac9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga06711a4e77ff8ab49e427010fd38ac9e">H5Adelete_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:ga06711a4e77ff8ab49e427010fd38ac9e"><td class="mdescLeft"> </td><td class="mdescRight">Deletes an attribute from an object according to index order. <br /></td></tr>
|
|
<tr class="separator:ga06711a4e77ff8ab49e427010fd38ac9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacbf689308f851428dd641b64f5f94feb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gacbf689308f851428dd641b64f5f94feb">H5Adelete_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, const char *attr_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:gacbf689308f851428dd641b64f5f94feb"><td class="mdescLeft"> </td><td class="mdescRight">Removes an attribute from a specified location. <br /></td></tr>
|
|
<tr class="separator:gacbf689308f851428dd641b64f5f94feb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga293b5be270d90cd5e47f782ca9aec80b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga293b5be270d90cd5e47f782ca9aec80b">H5Aexists</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, const char *attr_name)</td></tr>
|
|
<tr class="memdesc:ga293b5be270d90cd5e47f782ca9aec80b"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether an attribute with a given name exists on an object. <br /></td></tr>
|
|
<tr class="separator:ga293b5be270d90cd5e47f782ca9aec80b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa1d2305651a4524f6aa0f8b56eec1a37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gaa1d2305651a4524f6aa0f8b56eec1a37">H5Aexists_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, const char *obj_name, const char *attr_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:gaa1d2305651a4524f6aa0f8b56eec1a37"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether an attribute with a given name exists on an object. <br /></td></tr>
|
|
<tr class="separator:gaa1d2305651a4524f6aa0f8b56eec1a37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0f6b545850bd21f128904eff51df226d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga0f6b545850bd21f128904eff51df226d">H5Aget_create_plist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id)</td></tr>
|
|
<tr class="memdesc:ga0f6b545850bd21f128904eff51df226d"><td class="mdescLeft"> </td><td class="mdescRight">Gets an attribute creation property list identifier. <br /></td></tr>
|
|
<tr class="separator:ga0f6b545850bd21f128904eff51df226d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae3f1b7b87240b461f7827a8783acc08a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gae3f1b7b87240b461f7827a8783acc08a">H5Aget_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id, <a class="el" href="struct_h5_a__info__t.html">H5A_info_t</a> *ainfo)</td></tr>
|
|
<tr class="memdesc:gae3f1b7b87240b461f7827a8783acc08a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves attribute information by attribute identifier. <br /></td></tr>
|
|
<tr class="separator:gae3f1b7b87240b461f7827a8783acc08a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad110910cb227c15fdca938a642714fe9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gad110910cb227c15fdca938a642714fe9">H5Aget_info_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, <a class="el" href="struct_h5_a__info__t.html">H5A_info_t</a> *ainfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:gad110910cb227c15fdca938a642714fe9"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves attribute information by attribute index position. <br /></td></tr>
|
|
<tr class="separator:gad110910cb227c15fdca938a642714fe9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga258f03e12b4f49ad33ba72d17a9e2faf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga258f03e12b4f49ad33ba72d17a9e2faf">H5Aget_info_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, const char *attr_name, <a class="el" href="struct_h5_a__info__t.html">H5A_info_t</a> *ainfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:ga258f03e12b4f49ad33ba72d17a9e2faf"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves attribute information by attribute name. <br /></td></tr>
|
|
<tr class="separator:ga258f03e12b4f49ad33ba72d17a9e2faf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga05e195aabab8c623b1c52009aeb99674"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga05e195aabab8c623b1c52009aeb99674">H5Aget_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id, size_t buf_size, char *buf)</td></tr>
|
|
<tr class="memdesc:ga05e195aabab8c623b1c52009aeb99674"><td class="mdescLeft"> </td><td class="mdescRight">Gets an attribute name. <br /></td></tr>
|
|
<tr class="separator:ga05e195aabab8c623b1c52009aeb99674"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4c552b2db32371f8ea20d87475313fb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga4c552b2db32371f8ea20d87475313fb6">H5Aget_name_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, char *name, size_t size, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:ga4c552b2db32371f8ea20d87475313fb6"><td class="mdescLeft"> </td><td class="mdescRight">Gets an attribute name by attribute index position. <br /></td></tr>
|
|
<tr class="separator:ga4c552b2db32371f8ea20d87475313fb6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9e21e544119d03f9342530b45a71d74d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga9e21e544119d03f9342530b45a71d74d">H5Aget_space</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id)</td></tr>
|
|
<tr class="memdesc:ga9e21e544119d03f9342530b45a71d74d"><td class="mdescLeft"> </td><td class="mdescRight">Gets a copy of the dataspace for an attribute. <br /></td></tr>
|
|
<tr class="separator:ga9e21e544119d03f9342530b45a71d74d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabd11c8e11db0adde706e41a24a832f06"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gabd11c8e11db0adde706e41a24a832f06">H5Aget_storage_size</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id)</td></tr>
|
|
<tr class="memdesc:gabd11c8e11db0adde706e41a24a832f06"><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of storage used to store an attribute. <br /></td></tr>
|
|
<tr class="separator:gabd11c8e11db0adde706e41a24a832f06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0b070b714b2e535df2e1cb3005026a44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga0b070b714b2e535df2e1cb3005026a44">H5Aget_type</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id)</td></tr>
|
|
<tr class="memdesc:ga0b070b714b2e535df2e1cb3005026a44"><td class="mdescLeft"> </td><td class="mdescRight">Gets an attribute's datatype. <br /></td></tr>
|
|
<tr class="separator:ga0b070b714b2e535df2e1cb3005026a44"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9315a22b60468b6e996559b1b8a77251"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga9315a22b60468b6e996559b1b8a77251">H5Aiterate2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *idx, <a class="el" href="_h5_apublic_8h.html#a28fef0ded9a6c0eb12334c0d15dc3e74">H5A_operator2_t</a> op, void *op_data)</td></tr>
|
|
<tr class="memdesc:ga9315a22b60468b6e996559b1b8a77251"><td class="mdescLeft"> </td><td class="mdescRight">Calls a user-defined function for each attribute on an object. <br /></td></tr>
|
|
<tr class="separator:ga9315a22b60468b6e996559b1b8a77251"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga75db973d69b61f673f5cdf21ac624cef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga75db973d69b61f673f5cdf21ac624cef">H5Aiterate_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *idx, <a class="el" href="_h5_apublic_8h.html#a28fef0ded9a6c0eb12334c0d15dc3e74">H5A_operator2_t</a> op, void *op_data, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:ga75db973d69b61f673f5cdf21ac624cef"><td class="mdescLeft"> </td><td class="mdescRight">Calls user-defined function for each attribute on an object. <br /></td></tr>
|
|
<tr class="separator:ga75db973d69b61f673f5cdf21ac624cef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga59863b205b6d93b2145f0fbca49656f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7">H5Aopen</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, const char *attr_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id)</td></tr>
|
|
<tr class="memdesc:ga59863b205b6d93b2145f0fbca49656f7"><td class="mdescLeft"> </td><td class="mdescRight">Opens an attribute for an object specified by object identifier and attribute name. <br /></td></tr>
|
|
<tr class="separator:ga59863b205b6d93b2145f0fbca49656f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab1451cdff4f77dcf9feaee83c8179b2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gab1451cdff4f77dcf9feaee83c8179b2d">H5Aopen_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:gab1451cdff4f77dcf9feaee83c8179b2d"><td class="mdescLeft"> </td><td class="mdescRight">Opens the nth attribute attached to an object. <br /></td></tr>
|
|
<tr class="separator:gab1451cdff4f77dcf9feaee83c8179b2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadb49a0b5b9798d2e944d877adba8ae10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gadb49a0b5b9798d2e944d877adba8ae10">H5Aopen_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, const char *attr_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="memdesc:gadb49a0b5b9798d2e944d877adba8ae10"><td class="mdescLeft"> </td><td class="mdescRight">Opens an attribute for an object by object name and attribute name. <br /></td></tr>
|
|
<tr class="separator:gadb49a0b5b9798d2e944d877adba8ae10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaacb27a997f7c98e8a833d0fd63b58f1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gaacb27a997f7c98e8a833d0fd63b58f1c">H5Aread</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, void *buf)</td></tr>
|
|
<tr class="memdesc:gaacb27a997f7c98e8a833d0fd63b58f1c"><td class="mdescLeft"> </td><td class="mdescRight">Reads the value of an attribute. <br /></td></tr>
|
|
<tr class="separator:gaacb27a997f7c98e8a833d0fd63b58f1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga490dcd6db246c1fda7295badfce28203"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga490dcd6db246c1fda7295badfce28203">H5Arename</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *old_name, const char *new_name)</td></tr>
|
|
<tr class="memdesc:ga490dcd6db246c1fda7295badfce28203"><td class="mdescLeft"> </td><td class="mdescRight">Renames an attribute. <br /></td></tr>
|
|
<tr class="separator:ga490dcd6db246c1fda7295badfce28203"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab70871e205d57450c83efd9912be2b5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gab70871e205d57450c83efd9912be2b5c">H5Awrite</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, const void *buf)</td></tr>
|
|
<tr class="memdesc:gab70871e205d57450c83efd9912be2b5c"><td class="mdescLeft"> </td><td class="mdescRight">Writes data to an attribute. <br /></td></tr>
|
|
<tr class="separator:gab70871e205d57450c83efd9912be2b5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga21f8483c935d72187b98f5e7c2056140"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga21f8483c935d72187b98f5e7c2056140">H5Arename_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_name, const char *old_attr_name, const char *new_attr_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
|
|
<tr class="separator:ga21f8483c935d72187b98f5e7c2056140"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa30f5f6c277d6c46f8aa31e89cdba085"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gaa30f5f6c277d6c46f8aa31e89cdba085">H5Acreate1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> acpl_id)</td></tr>
|
|
<tr class="memdesc:gaa30f5f6c277d6c46f8aa31e89cdba085"><td class="mdescLeft"> </td><td class="mdescRight">Creates an attribute attached to a specified object. <br /></td></tr>
|
|
<tr class="separator:gaa30f5f6c277d6c46f8aa31e89cdba085"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaadd809fc16238754105bbddd20bcdde1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gaadd809fc16238754105bbddd20bcdde1">H5Aget_num_attrs</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id)</td></tr>
|
|
<tr class="memdesc:gaadd809fc16238754105bbddd20bcdde1"><td class="mdescLeft"> </td><td class="mdescRight">Determines the number of attributes attached to an object. <br /></td></tr>
|
|
<tr class="separator:gaadd809fc16238754105bbddd20bcdde1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabdb2cf7368eec0ad998cbe6a3f61aa41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gabdb2cf7368eec0ad998cbe6a3f61aa41">H5Aiterate1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, unsigned *idx, <a class="el" href="_h5_apublic_8h.html#ae42c937252ed79a1ad4672f04adba750">H5A_operator1_t</a> op, void *op_data)</td></tr>
|
|
<tr class="memdesc:gabdb2cf7368eec0ad998cbe6a3f61aa41"><td class="mdescLeft"> </td><td class="mdescRight">Calls a user's function for each attribute on an object. <br /></td></tr>
|
|
<tr class="separator:gabdb2cf7368eec0ad998cbe6a3f61aa41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadaa85276f2731ad78462a6fd27118470"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#gadaa85276f2731ad78462a6fd27118470">H5Aopen_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, unsigned idx)</td></tr>
|
|
<tr class="memdesc:gadaa85276f2731ad78462a6fd27118470"><td class="mdescLeft"> </td><td class="mdescRight">Opens the attribute specified by its index. <br /></td></tr>
|
|
<tr class="separator:gadaa85276f2731ad78462a6fd27118470"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5c05fade96b6b7e2299f56a5b1edb1c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_a.html#ga5c05fade96b6b7e2299f56a5b1edb1c1">H5Aopen_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name)</td></tr>
|
|
<tr class="memdesc:ga5c05fade96b6b7e2299f56a5b1edb1c1"><td class="mdescLeft"> </td><td class="mdescRight">Opens an attribute specified by name. <br /></td></tr>
|
|
<tr class="separator:ga5c05fade96b6b7e2299f56a5b1edb1c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ga4a76e4e5ab6eb0fd2aa7990d38d55f24" name="ga4a76e4e5ab6eb0fd2aa7990d38d55f24"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4a76e4e5ab6eb0fd2aa7990d38d55f24">◆ </a></span>H5Acreate</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define H5Acreate   <a class="el" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308">H5Acreate2</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="group___h5_a.html#ga4a76e4e5ab6eb0fd2aa7990d38d55f24">H5Acreate()</a> is a macro that is mapped to either <a class="el" href="group___h5_a.html#gaa30f5f6c277d6c46f8aa31e89cdba085" title="Creates an attribute attached to a specified object.">H5Acreate1()</a> or <a class="el" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308" title="Creates an attribute attached to a specified object.">H5Acreate2()</a>.<br />
|
|
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab9dcfc543cd4282f32b8ea19e08ffa6c" name="gab9dcfc543cd4282f32b8ea19e08ffa6c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab9dcfc543cd4282f32b8ea19e08ffa6c">◆ </a></span>H5Aiterate</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define H5Aiterate   <a class="el" href="group___h5_a.html#ga9315a22b60468b6e996559b1b8a77251">H5Aiterate2</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="group___h5_a.html#gab9dcfc543cd4282f32b8ea19e08ffa6c">H5Aiterate()</a> is a macro that is mapped to either <a class="el" href="group___h5_a.html#gabdb2cf7368eec0ad998cbe6a3f61aa41" title="Calls a user's function for each attribute on an object.">H5Aiterate1()</a> or <a class="el" href="group___h5_a.html#ga9315a22b60468b6e996559b1b8a77251" title="Calls a user-defined function for each attribute on an object.">H5Aiterate2()</a>.<br />
|
|
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gaef4394b661e2c930879e9868e122bdda" name="gaef4394b661e2c930879e9868e122bdda"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaef4394b661e2c930879e9868e122bdda">◆ </a></span>H5Aclose()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Aclose </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>attr_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Closes the specified attribute. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_id</td><td>Attribute identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> terminates access to the attribute through <code>attr_id</code> and releases the identifier.</p>
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div>
|
|
<div class="line"> __label__ fail_acpl, fail_attr, fail_file;</div>
|
|
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, acpl, fspace, attr;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code hl_define" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> file_name[] = <span class="stringliteral">"f1.h5"</span>;</div>
|
|
<div class="line"> <span class="comment">// attribute names can be arbitrary Unicode strings</span></div>
|
|
<div class="line"> <span class="keywordtype">char</span> attr_name[] = <span class="stringliteral">"Χαρακτηριστικό"</span>;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a>(file_name, mode, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_file;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((acpl = <a class="code hl_function" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code hl_define" href="_h5_ppublic_8h.html#aa0102211c679e031e2e9831b66c48a12">H5P_ATTRIBUTE_CREATE</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_acpl;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// use UTF-8 encoding for the attribute name</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc">H5Pset_char_encoding</a>(acpl, <a class="code hl_enumvalue" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a>) < 0) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_fspace;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// create a scalar (singleton) attribute</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((fspace = <a class="code hl_function" href="group___h5_s.html#gabee514327cba34ca9951b24fa14fb083">H5Screate</a>(<a class="code hl_enumvalue" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aaf6a34a2439db8aa7bb63ed0c4aaa5eb8">H5S_SCALAR</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_fspace;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// create an attribute on the root group</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((attr = <a class="code hl_function" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308">H5Acreate2</a>(file, attr_name, <a class="code hl_define" href="group___p_d_t_s_t_d.html#ga8db8c9c2bcc457f9f8526c8fcb81218b">H5T_STD_I32LE</a>, fspace, acpl, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) ==</div>
|
|
<div class="line"> <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_attr;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda">H5Aclose</a>(attr);</div>
|
|
<div class="line">fail_attr:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1">H5Sclose</a>(fspace);</div>
|
|
<div class="line">fail_fspace:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(acpl);</div>
|
|
<div class="line">fail_acpl:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
|
|
<div class="line">fail_file:;</div>
|
|
<div class="line"> }</div>
|
|
<div class="ttc" id="a_h5_fpublic_8h_html_a5a2d6726f9ad8d2bca8df2b817e5ad6a"><div class="ttname"><a href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a></div><div class="ttdeci">#define H5F_ACC_TRUNC</div><div class="ttdef"><b>Definition</b> H5Fpublic.h:50</div></div>
|
|
<div class="ttc" id="a_h5_ipublic_8h_html_a0045db7ff9c22ad35db6ae91662e1943"><div class="ttname"><a href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></div><div class="ttdeci">int64_t hid_t</div><div class="ttdef"><b>Definition</b> H5Ipublic.h:60</div></div>
|
|
<div class="ttc" id="a_h5_ipublic_8h_html_a01eab13dccc91afd6909d74dccb780ba"><div class="ttname"><a href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a></div><div class="ttdeci">#define H5I_INVALID_HID</div><div class="ttdef"><b>Definition</b> H5Ipublic.h:75</div></div>
|
|
<div class="ttc" id="a_h5_ppublic_8h_html_aa0102211c679e031e2e9831b66c48a12"><div class="ttname"><a href="_h5_ppublic_8h.html#aa0102211c679e031e2e9831b66c48a12">H5P_ATTRIBUTE_CREATE</a></div><div class="ttdeci">#define H5P_ATTRIBUTE_CREATE</div><div class="ttdef"><b>Definition</b> H5Ppublic.h:112</div></div>
|
|
<div class="ttc" id="a_h5_ppublic_8h_html_afa85e97bfbf9bf1c58e39263846c568f"><div class="ttname"><a href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a></div><div class="ttdeci">#define H5P_DEFAULT</div><div class="ttdef"><b>Definition</b> H5Ppublic.h:228</div></div>
|
|
<div class="ttc" id="a_h5_spublic_8h_html_ae53f3c6a52563646fbac9ead8ecdbf0aaf6a34a2439db8aa7bb63ed0c4aaa5eb8"><div class="ttname"><a href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aaf6a34a2439db8aa7bb63ed0c4aaa5eb8">H5S_SCALAR</a></div><div class="ttdeci">@ H5S_SCALAR</div><div class="ttdef"><b>Definition</b> H5Spublic.h:77</div></div>
|
|
<div class="ttc" id="a_h5_tpublic_8h_html_a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658"><div class="ttname"><a href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a></div><div class="ttdeci">@ H5T_CSET_UTF8</div><div class="ttdef"><b>Definition</b> H5Tpublic.h:96</div></div>
|
|
<div class="ttc" id="agroup___a_c_p_l_html_gad4fa8e2d17236786f770cf17eef908cc"><div class="ttname"><a href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc">H5Pset_char_encoding</a></div><div class="ttdeci">herr_t H5Pset_char_encoding(hid_t plist_id, H5T_cset_t encoding)</div><div class="ttdoc">Sets the character encoding used to encode link and attribute names.</div></div>
|
|
<div class="ttc" id="agroup___h5_a_html_ga4f4e5248c09f689633079ed8afc0b308"><div class="ttname"><a href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308">H5Acreate2</a></div><div class="ttdeci">hid_t H5Acreate2(hid_t loc_id, const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id, hid_t aapl_id)</div><div class="ttdoc">Creates an attribute attached to a specified object.</div></div>
|
|
<div class="ttc" id="agroup___h5_a_html_gaef4394b661e2c930879e9868e122bdda"><div class="ttname"><a href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda">H5Aclose</a></div><div class="ttdeci">herr_t H5Aclose(hid_t attr_id)</div><div class="ttdoc">Closes the specified attribute.</div></div>
|
|
<div class="ttc" id="agroup___h5_f_html_gac55cd91d80822e4f8c2a7f04ea71b124"><div class="ttname"><a href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a></div><div class="ttdeci">herr_t H5Fclose(hid_t file_id)</div><div class="ttdoc">Terminates access to an HDF5 file.</div></div>
|
|
<div class="ttc" id="agroup___h5_f_html_gae64b51ee9ac0781bc4ccc599d98387f4"><div class="ttname"><a href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a></div><div class="ttdeci">hid_t H5Fcreate(const char *filename, unsigned flags, hid_t fcpl_id, hid_t fapl_id)</div><div class="ttdoc">Creates an HDF5 file.</div></div>
|
|
<div class="ttc" id="agroup___h5_s_html_ga2b53128a39c8f104c1c9c2a91590fcc1"><div class="ttname"><a href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1">H5Sclose</a></div><div class="ttdeci">herr_t H5Sclose(hid_t space_id)</div><div class="ttdoc">Releases and terminates access to a dataspace.</div></div>
|
|
<div class="ttc" id="agroup___h5_s_html_gabee514327cba34ca9951b24fa14fb083"><div class="ttname"><a href="group___h5_s.html#gabee514327cba34ca9951b24fa14fb083">H5Screate</a></div><div class="ttdeci">hid_t H5Screate(H5S_class_t type)</div><div class="ttdoc">Creates a new dataspace of a specified type.</div></div>
|
|
<div class="ttc" id="agroup___p_d_t_s_t_d_html_ga8db8c9c2bcc457f9f8526c8fcb81218b"><div class="ttname"><a href="group___p_d_t_s_t_d.html#ga8db8c9c2bcc457f9f8526c8fcb81218b">H5T_STD_I32LE</a></div><div class="ttdeci">#define H5T_STD_I32LE</div><div class="ttdef"><b>Definition</b> H5Tpublic.h:323</div></div>
|
|
<div class="ttc" id="agroup___p_l_c_r_html_ga5dce61149211d3ef319452aa598887fb"><div class="ttname"><a href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a></div><div class="ttdeci">herr_t H5Pclose(hid_t plist_id)</div><div class="ttdoc">Terminates access to a property list.</div></div>
|
|
<div class="ttc" id="agroup___p_l_c_r_html_gaf1b11da01d4d45d788c45f8bc5f0cbfa"><div class="ttname"><a href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a></div><div class="ttdeci">hid_t H5Pcreate(hid_t cls_id)</div><div class="ttdoc">Creates a new property list as an instance of a property list class.</div></div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_a.html#ga4a76e4e5ab6eb0fd2aa7990d38d55f24">H5Acreate()</a>, <a class="el" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7" title="Opens an attribute for an object specified by object identifier and attribute name.">H5Aopen()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa30f5f6c277d6c46f8aa31e89cdba085" name="gaa30f5f6c277d6c46f8aa31e89cdba085"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa30f5f6c277d6c46f8aa31e89cdba085">◆ </a></span>H5Acreate1()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Acreate1 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </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"><em>type_id</em>, </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"><em>space_id</em>, </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"><em>acpl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates an attribute attached to a specified object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of attribute to locate and open </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Identifier of attribute datatype </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">acpl_id</td><td>Attribute creation property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>Superseded by <a class="el" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308" title="Creates an attribute attached to a specified object.">H5Acreate2()</a>.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>The <code>acpl</code> parameter is currently not used; specify <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gaa30f5f6c277d6c46f8aa31e89cdba085" title="Creates an attribute attached to a specified object.">H5Acreate1()</a> creates an attribute, <code>name</code>, which is attached to the object specified by the identifier <code>loc_id</code>.</p>
|
|
<p>The attribute name, <code>name</code>, must be unique for the object.</p>
|
|
<p>The attribute is created with the specified datatype and dataspace, <code>type_id</code> and <code>space_id</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>1.8.0 The function <a class="el" href="group___h5_a.html#ga4a76e4e5ab6eb0fd2aa7990d38d55f24">H5Acreate()</a> was renamed to <a class="el" href="group___h5_a.html#gaa30f5f6c277d6c46f8aa31e89cdba085" title="Creates an attribute attached to a specified object.">H5Acreate1()</a> and deprecated in this release.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4f4e5248c09f689633079ed8afc0b308" name="ga4f4e5248c09f689633079ed8afc0b308"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4f4e5248c09f689633079ed8afc0b308">◆ </a></span>H5Acreate2()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Acreate2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attr_name</em>, </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"><em>type_id</em>, </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"><em>space_id</em>, </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"><em>acpl_id</em>, </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"><em>aapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates an attribute attached to a specified object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Name of attribute </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Attribute datatype identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">acpl_id</td><td>Attribute creation property list identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">aapl_id</td><td>Attribute access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308" title="Creates an attribute attached to a specified object.">H5Acreate2()</a> creates an attribute, <code>attr_name</code>, which is attached to the object specified by the identifier <code>loc_id</code>.</p>
|
|
<p>The attribute name, <code>attr_name</code>, must be unique for the object.</p>
|
|
<p>The attribute is created with the specified datatype and dataspace, <code>type_id</code> and <code>space_id</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The <code>aapl_id</code> parameter is currently not used; specify <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</dd></dl>
|
|
<p>The attribute identifier returned by this function must be released with <a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> or resource leaks will develop.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>If <code>loc_id</code> is a file identifier, the attribute will be attached to that file's root group.</dd></dl>
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div>
|
|
<div class="line"> __label__ fail_acpl, fail_attr, fail_file;</div>
|
|
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, acpl, fspace, attr;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code hl_define" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> file_name[] = <span class="stringliteral">"f1.h5"</span>;</div>
|
|
<div class="line"> <span class="comment">// attribute names can be arbitrary Unicode strings</span></div>
|
|
<div class="line"> <span class="keywordtype">char</span> attr_name[] = <span class="stringliteral">"Χαρακτηριστικό"</span>;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a>(file_name, mode, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_file;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((acpl = <a class="code hl_function" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code hl_define" href="_h5_ppublic_8h.html#aa0102211c679e031e2e9831b66c48a12">H5P_ATTRIBUTE_CREATE</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_acpl;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// use UTF-8 encoding for the attribute name</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc">H5Pset_char_encoding</a>(acpl, <a class="code hl_enumvalue" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a>) < 0) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_fspace;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// create a scalar (singleton) attribute</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((fspace = <a class="code hl_function" href="group___h5_s.html#gabee514327cba34ca9951b24fa14fb083">H5Screate</a>(<a class="code hl_enumvalue" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aaf6a34a2439db8aa7bb63ed0c4aaa5eb8">H5S_SCALAR</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_fspace;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// create an attribute on the root group</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((attr = <a class="code hl_function" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308">H5Acreate2</a>(file, attr_name, <a class="code hl_define" href="group___p_d_t_s_t_d.html#ga8db8c9c2bcc457f9f8526c8fcb81218b">H5T_STD_I32LE</a>, fspace, acpl, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) ==</div>
|
|
<div class="line"> <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_attr;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda">H5Aclose</a>(attr);</div>
|
|
<div class="line">fail_attr:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1">H5Sclose</a>(fspace);</div>
|
|
<div class="line">fail_fspace:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(acpl);</div>
|
|
<div class="line">fail_acpl:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
|
|
<div class="line">fail_file:;</div>
|
|
<div class="line"> }</div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga004160c28e281455ec48aa7fe557ef8a" name="ga004160c28e281455ec48aa7fe557ef8a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga004160c28e281455ec48aa7fe557ef8a">◆ </a></span>H5Acreate_by_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Acreate_by_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attr_name</em>, </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"><em>type_id</em>, </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"><em>space_id</em>, </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"><em>acpl_id</em>, </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"><em>aapl_id</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates an attribute attached to a specified object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name, relative to <code>loc_id</code>, of object that attribute is to be attached to </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Attribute name </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Attribute datatype identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">acpl_id</td><td>Attribute creation property list identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">aapl_id</td><td>Attribute access property list identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga004160c28e281455ec48aa7fe557ef8a" title="Creates an attribute attached to a specified object.">H5Acreate_by_name()</a> creates an attribute, <code>attr_name</code>, which is attached to the object specified by <code>loc_id</code> and <code>obj_name</code>.</p>
|
|
<p><code>loc_id</code> is a location identifier; <code>obj_name</code> is the object name relative to <code>loc_id</code>.</p>
|
|
<p>The attribute name, <code>attr_name</code>, must be unique for the object.</p>
|
|
<p>The attribute is created with the specified datatype and dataspace, <code>type_id</code> and <code>space_id</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The <code>aapl_id</code> parameter is currently not used; specify <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</dd></dl>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gada9fa3d6db52329f1fd55662de6ff6ba" name="gada9fa3d6db52329f1fd55662de6ff6ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gada9fa3d6db52329f1fd55662de6ff6ba">◆ </a></span>H5Adelete()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Adelete </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attr_name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deletes an attribute from a specified location. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Name of the attribute to delete</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="group___h5_a.html#gada9fa3d6db52329f1fd55662de6ff6ba" title="Deletes an attribute from a specified location.">H5Adelete()</a> removes the attribute specified by its name, <code>attr_name</code>, from a file, dataset, group, or named datatype.</p>
|
|
<dl class="section attention"><dt>Attention</dt><dd>This function should not be used when other attribute identifiers are open on <code>loc_id</code>. This may cause the internal indexes of the attributes to change and future writes to the open attributes to produce incorrect results.</dd></dl>
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div>
|
|
<div class="line"> __label__ fail_attr, fail_file;</div>
|
|
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code hl_define" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> file_name[] = <span class="stringliteral">"f1.h5"</span>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> attr_name[] = <span class="stringliteral">"Χαρακτηριστικό"</span>;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(file_name, mode, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_file;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// delete the attribute</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___h5_a.html#gada9fa3d6db52329f1fd55662de6ff6ba">H5Adelete</a>(file, attr_name) < 0) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_attr;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> </div>
|
|
<div class="line">fail_attr:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
|
|
<div class="line">fail_file:;</div>
|
|
<div class="line"> }</div>
|
|
<div class="ttc" id="a_h5_fpublic_8h_html_a402673dec5c537b27a49a9a8bd6140b4"><div class="ttname"><a href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a></div><div class="ttdeci">#define H5F_ACC_RDWR</div><div class="ttdef"><b>Definition</b> H5Fpublic.h:49</div></div>
|
|
<div class="ttc" id="agroup___h5_a_html_gada9fa3d6db52329f1fd55662de6ff6ba"><div class="ttname"><a href="group___h5_a.html#gada9fa3d6db52329f1fd55662de6ff6ba">H5Adelete</a></div><div class="ttdeci">herr_t H5Adelete(hid_t loc_id, const char *attr_name)</div><div class="ttdoc">Deletes an attribute from a specified location.</div></div>
|
|
<div class="ttc" id="agroup___h5_f_html_gaa3f4f877b9bb591f3880423ed2bf44bc"><div class="ttname"><a href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a></div><div class="ttdeci">hid_t H5Fopen(const char *filename, unsigned flags, hid_t fapl_id)</div><div class="ttdoc">Opens an existing HDF5 file.</div></div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga06711a4e77ff8ab49e427010fd38ac9e" name="ga06711a4e77ff8ab49e427010fd38ac9e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga06711a4e77ff8ab49e427010fd38ac9e">◆ </a></span>H5Adelete_by_idx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Adelete_by_idx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> </td>
|
|
<td class="paramname"><em>idx_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> </td>
|
|
<td class="paramname"><em>order</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>n</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deletes an attribute from an object according to index order. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name of object, relative to location, from which attribute is to be removed </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Type of index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Order in which to iterate over the index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Offset within the index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga06711a4e77ff8ab49e427010fd38ac9e" title="Deletes an attribute from an object according to index order.">H5Adelete_by_idx()</a> removes an attribute specified by its location in an index, from an object.</p>
|
|
<p>The object from which the attribute is to be removed is specified by a location identifier and name, <code>loc_id</code> and <code>obj_name</code>, respectively.</p>
|
|
<p>The attribute to be removed is specified by a position in an index, <code>n</code>. The type of index is specified by <code>idx_type</code>. The order in which the index is to be traversed is specified by <code>order</code>. For example, if <code>idx_type</code>, <code>order</code>, and <code>n</code> are set to <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a>, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a>, and 5, respectively, the fifth attribute in the lexicographic order of attribute names will be removed.</p>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gacbf689308f851428dd641b64f5f94feb" name="gacbf689308f851428dd641b64f5f94feb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacbf689308f851428dd641b64f5f94feb">◆ </a></span>H5Adelete_by_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Adelete_by_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attr_name</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Removes an attribute from a specified location. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name of object, relative to location, from which attribute is to be removed </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Name of attribute to delete </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gacbf689308f851428dd641b64f5f94feb" title="Removes an attribute from a specified location.">H5Adelete_by_name()</a> removes the attribute <code>attr_name</code> from an object specified by location and name, <code>loc_id</code> and <code>obj_name</code>, respectively.</p>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga293b5be270d90cd5e47f782ca9aec80b" name="ga293b5be270d90cd5e47f782ca9aec80b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga293b5be270d90cd5e47f782ca9aec80b">◆ </a></span>H5Aexists()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Aexists </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>obj_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attr_name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines whether an attribute with a given name exists on an object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Attribute name</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="group___h5_a.html#ga293b5be270d90cd5e47f782ca9aec80b" title="Determines whether an attribute with a given name exists on an object.">H5Aexists()</a> determines whether the attribute <code>attr_name</code> exists on the object specified by <code>obj_id</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa1d2305651a4524f6aa0f8b56eec1a37" name="gaa1d2305651a4524f6aa0f8b56eec1a37"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa1d2305651a4524f6aa0f8b56eec1a37">◆ </a></span>H5Aexists_by_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Aexists_by_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>obj_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attr_name</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines whether an attribute with a given name exists on an object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Object name </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Attribute name </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gaa1d2305651a4524f6aa0f8b56eec1a37" title="Determines whether an attribute with a given name exists on an object.">H5Aexists_by_name()</a> determines whether the attribute <code>attr_name</code> exists on an object. That object is specified by its location and name, <code>loc_id</code> and <code>obj_name</code>, respectively.</p>
|
|
<p><code>loc_id</code> specifies a location in the file containing the object. <code>obj_name</code> is the name of the object to which the attribute is attached and can be a relative name, relative to <code>loc_id</code>, or an absolute name, based on the root group of the file.</p>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access <code>obj_name</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0f6b545850bd21f128904eff51df226d" name="ga0f6b545850bd21f128904eff51df226d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0f6b545850bd21f128904eff51df226d">◆ </a></span>H5Aget_create_plist()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Aget_create_plist </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>attr_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets an attribute creation property list identifier. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_id</td><td>Attribute identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute's creation property list identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga0f6b545850bd21f128904eff51df226d" title="Gets an attribute creation property list identifier.">H5Aget_create_plist()</a> returns an identifier for the attribute creation property list associated with the attribute specified by <code>attr_id</code>.</p>
|
|
<p>The creation property list identifier should be released with <a class="el" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb" title="Terminates access to a property list.">H5Pclose()</a> to prevent resource leaks.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae3f1b7b87240b461f7827a8783acc08a" name="gae3f1b7b87240b461f7827a8783acc08a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae3f1b7b87240b461f7827a8783acc08a">◆ </a></span>H5Aget_info()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Aget_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>attr_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_h5_a__info__t.html">H5A_info_t</a> * </td>
|
|
<td class="paramname"><em>ainfo</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves attribute information by attribute identifier. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_id</td><td>Attribute identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">ainfo</td><td>Attribute information struct</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="group___h5_a.html#gae3f1b7b87240b461f7827a8783acc08a" title="Retrieves attribute information by attribute identifier.">H5Aget_info()</a> retrieves attribute information, locating the attribute with an attribute identifier, <code>attr_id</code>. The attribute information is returned in the <code>ainfo</code> struct.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad110910cb227c15fdca938a642714fe9" name="gad110910cb227c15fdca938a642714fe9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad110910cb227c15fdca938a642714fe9">◆ </a></span>H5Aget_info_by_idx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Aget_info_by_idx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> </td>
|
|
<td class="paramname"><em>idx_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> </td>
|
|
<td class="paramname"><em>order</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>n</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_h5_a__info__t.html">H5A_info_t</a> * </td>
|
|
<td class="paramname"><em>ainfo</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves attribute information by attribute index position. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name of object to which attribute is attached, relative to location </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Type of index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Index traversal order </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Attribute's position in index </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">ainfo</td><td>Struct containing returned attribute information </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gad110910cb227c15fdca938a642714fe9" title="Retrieves attribute information by attribute index position.">H5Aget_info_by_idx()</a> retrieves information for an attribute that is attached to an object, which is specified by its location and name, <code>loc_id</code> and <code>obj_name</code>, respectively. The attribute is located by its index position, and the attribute information is returned in the <code>ainfo</code> struct.</p>
|
|
<p>The attribute is located by means of an index type, an index traversal order, and a position in the index, <code>idx_type</code>, <code>order</code> and <code>n</code>, respectively.</p>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga258f03e12b4f49ad33ba72d17a9e2faf" name="ga258f03e12b4f49ad33ba72d17a9e2faf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga258f03e12b4f49ad33ba72d17a9e2faf">◆ </a></span>H5Aget_info_by_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Aget_info_by_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attr_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_h5_a__info__t.html">H5A_info_t</a> * </td>
|
|
<td class="paramname"><em>ainfo</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves attribute information by attribute name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name of the object to which an attribute is attached, relative to location </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Attribute name </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">ainfo</td><td>Struct containing returned attribute information </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga258f03e12b4f49ad33ba72d17a9e2faf" title="Retrieves attribute information by attribute name.">H5Aget_info_by_name()</a> retrieves information for an attribute, <code>attr_name</code>, that is attached to an object specified by its location and name, <code>loc_id</code> and <code>obj_name</code>, respectively. The attribute information is returned in the <code>ainfo</code> struct.</p>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga05e195aabab8c623b1c52009aeb99674" name="ga05e195aabab8c623b1c52009aeb99674"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga05e195aabab8c623b1c52009aeb99674">◆ </a></span>H5Aget_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Aget_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>attr_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>buf_size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>buf</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets an attribute name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_id</td><td>Attribute identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">buf_size</td><td>The size of the buffer to store the name in </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to store name in</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the length of the attribute's name, which may be longer than <code>buf_size</code>, if successful. Otherwise, returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga05e195aabab8c623b1c52009aeb99674" title="Gets an attribute name.">H5Aget_name()</a> retrieves the name of an attribute specified by the identifier, <code>attr_id</code>.</p>
|
|
<p>Up to <code>size</code> characters of the attribute name are returned in <code>name</code>; additional characters, if any, are not returned to the user application.<br />
|
|
<br />
|
|
If the length of the attribute name, which determines the required value of <code>size</code>, is unknown, a preliminary call to <a class="el" href="group___h5_a.html#ga05e195aabab8c623b1c52009aeb99674" title="Gets an attribute name.">H5Aget_name()</a> with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the attribute name. That value, plus 1 for a NULL terminator, must then be assigned to <code>size</code> for a second <a class="el" href="group___h5_a.html#ga05e195aabab8c623b1c52009aeb99674" title="Gets an attribute name.">H5Aget_name()</a> call, which will retrieve the actual attribute name.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4c552b2db32371f8ea20d87475313fb6" name="ga4c552b2db32371f8ea20d87475313fb6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4c552b2db32371f8ea20d87475313fb6">◆ </a></span>H5Aget_name_by_idx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Aget_name_by_idx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> </td>
|
|
<td class="paramname"><em>idx_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> </td>
|
|
<td class="paramname"><em>order</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>n</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets an attribute name by attribute index position. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name of object to which attribute is attached, relative to location </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Type of index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Index traversal order </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Attribute's position in index </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Attribute name </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size, in bytes, of attribute name </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns attribute name size, in bytes, if successful; otherwise, returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga4c552b2db32371f8ea20d87475313fb6" title="Gets an attribute name by attribute index position.">H5Aget_name_by_idx()</a> retrieves the name of an attribute that is attached to an object, which is specified by its location and name, <code>loc_id</code> and <code>obj_name</code>, respectively. The attribute is located by its index position, the size of the name is specified in <code>size</code>, and the attribute name is returned in <code>name</code>.</p>
|
|
<p>The attribute is located by means of an index type, an index traversal order, and a position in the index, <code>idx_type</code>, <code>order</code> and <code>n</code>, respectively.</p>
|
|
<p>Up to <code>size</code> characters of the attribute name are returned in <code>name</code>; additional characters, if any, are not returned to the user application.<br />
|
|
<br />
|
|
If the length of the attribute name, which determines the required value of <code>size</code>, is unknown, a preliminary call to <a class="el" href="group___h5_a.html#ga4c552b2db32371f8ea20d87475313fb6" title="Gets an attribute name by attribute index position.">H5Aget_name_by_idx()</a> with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the attribute name. That value, plus 1 for a NULL terminator, must then be assigned to <code>size</code> for a second <a class="el" href="group___h5_a.html#ga4c552b2db32371f8ea20d87475313fb6" title="Gets an attribute name by attribute index position.">H5Aget_name_by_idx()</a> call, which will retrieve the actual attribute name.</p>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaadd809fc16238754105bbddd20bcdde1" name="gaadd809fc16238754105bbddd20bcdde1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaadd809fc16238754105bbddd20bcdde1">◆ </a></span>H5Aget_num_attrs()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int H5Aget_num_attrs </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines the number of attributes attached to an object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of attributes if successful; otherwise, returns a negative value.</dd></dl>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>Superseded by <a class="el" href="group___h5_o.html#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a>, <a class="el" href="group___h5_o.html#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name()</a>, and <a class="el" href="group___h5_o.html#gafe764884e1530f86079288dd5895a7bd">H5Oget_info_by_idx()</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gaadd809fc16238754105bbddd20bcdde1" title="Determines the number of attributes attached to an object.">H5Aget_num_attrs()</a> returns the number of attributes attached to the object specified by its identifier, <code>loc_id</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9e21e544119d03f9342530b45a71d74d" name="ga9e21e544119d03f9342530b45a71d74d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9e21e544119d03f9342530b45a71d74d">◆ </a></span>H5Aget_space()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Aget_space </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>attr_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets a copy of the dataspace for an attribute. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_id</td><td>Attribute identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute dataspace identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga9e21e544119d03f9342530b45a71d74d" title="Gets a copy of the dataspace for an attribute.">H5Aget_space()</a> retrieves a copy of the dataspace for an attribute. The dataspace identifier returned from this function must be released with <a class="el" href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1" title="Releases and terminates access to a dataspace.">H5Sclose()</a> or resource leaks will develop.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gabd11c8e11db0adde706e41a24a832f06" name="gabd11c8e11db0adde706e41a24a832f06"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabd11c8e11db0adde706e41a24a832f06">◆ </a></span>H5Aget_storage_size()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> H5Aget_storage_size </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>attr_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the amount of storage used to store an attribute. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_id</td><td>Attribute identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the amount of storage size allocated for the attribute; otherwise, returns 0 (zero).</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gabd11c8e11db0adde706e41a24a832f06" title="Returns the amount of storage used to store an attribute.">H5Aget_storage_size()</a> returns the amount of storage that is required for the specified attribute, <code>attr_id</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0b070b714b2e535df2e1cb3005026a44" name="ga0b070b714b2e535df2e1cb3005026a44"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0b070b714b2e535df2e1cb3005026a44">◆ </a></span>H5Aget_type()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Aget_type </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>attr_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets an attribute's datatype. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_id</td><td>Attribute identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a datatype identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga0b070b714b2e535df2e1cb3005026a44" title="Gets an attribute's datatype.">H5Aget_type()</a> retrieves a copy of the attribute's datatype. The datatype is reopened if it is a named type before returning it to the application. The datatypes returned by this function are always read-only.</p>
|
|
<p>The datatype identifier returned from this function must be released with <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a> or resource leaks will develop.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gabdb2cf7368eec0ad998cbe6a3f61aa41" name="gabdb2cf7368eec0ad998cbe6a3f61aa41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabdb2cf7368eec0ad998cbe6a3f61aa41">◆ </a></span>H5Aiterate1()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Aiterate1 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned * </td>
|
|
<td class="paramname"><em>idx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_apublic_8h.html#ae42c937252ed79a1ad4672f04adba750">H5A_operator1_t</a> </td>
|
|
<td class="paramname"><em>op</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>op_data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calls a user's function for each attribute on an object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Starting (in) and ending (out) attribute index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>User's function to pass each attribute to </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">op_data</td><td>User's data to pass through to the iterator operator function</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd>Superseded by <a class="el" href="group___h5_a.html#ga9315a22b60468b6e996559b1b8a77251" title="Calls a user-defined function for each attribute on an object.">H5Aiterate2()</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gabdb2cf7368eec0ad998cbe6a3f61aa41" title="Calls a user's function for each attribute on an object.">H5Aiterate1()</a> iterates over the attributes of the object specified by its identifier, <code>loc_id</code>. The object can be a group, dataset, or named datatype. For each attribute of the object, the <code>op_data</code> and some additional information specified below are passed to the operator function <code>op</code>. The iteration begins with the attribute specified by its index, <code>idx</code>; the index for the next attribute to be processed by the operator, <code>op</code>, is returned in <code>idx</code>. If <code>idx</code> is the null pointer, then all attributes are processed.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Adding or removing attributes to the object during iteration will lead to undefined behavior.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>1.8.0 The function <code>H5Aiterate</code> was renamed to <a class="el" href="group___h5_a.html#gabdb2cf7368eec0ad998cbe6a3f61aa41" title="Calls a user's function for each attribute on an object.">H5Aiterate1()</a> and deprecated in this release. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9315a22b60468b6e996559b1b8a77251" name="ga9315a22b60468b6e996559b1b8a77251"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9315a22b60468b6e996559b1b8a77251">◆ </a></span>H5Aiterate2()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Aiterate2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> </td>
|
|
<td class="paramname"><em>idx_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> </td>
|
|
<td class="paramname"><em>order</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td>
|
|
<td class="paramname"><em>idx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_apublic_8h.html#a28fef0ded9a6c0eb12334c0d15dc3e74">H5A_operator2_t</a> </td>
|
|
<td class="paramname"><em>op</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>op_data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calls a user-defined function for each attribute on an object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Type of index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Order in which to iterate over index </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Initial and returned offset within index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>User-defined function to pass each attribute to </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">op_data</td><td>User data to pass through to and to be returned by iterator operator function</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. Further note that this function returns the return value of the last operator if it was non-zero, which can be a negative value, zero if all attributes were processed, or a positive value indicating short-circuit success.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga9315a22b60468b6e996559b1b8a77251" title="Calls a user-defined function for each attribute on an object.">H5Aiterate2()</a> iterates over the attributes attached to a dataset, named datatype, or group, as specified by <code>loc_id</code>. For each attribute, user-provided data, <code>op_data</code>, with additional information, as defined below, is passed to a user-defined function, <code>op</code>, which operates on that attribute.</p>
|
|
<p>The order of the iteration and the attributes iterated over are specified by three parameters: the index type, <code>idx_type</code>; the order in which the index is to be traversed, <code>order</code>; and the attribute's position in the index, <code>idx</code>. The next attribute to be operated on is specified by <code>idx</code>, a position in the index.</p>
|
|
<p>For example, if <code>idx_type</code>, <code>order</code>, and <code>idx</code> are set to <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a>, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a>, and 5, respectively, the attribute in question is the fifth attribute from the beginning of the alphanumeric index of attribute names. If <code>order</code> were set to <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a>, it would be the fifth attribute from the end of the index.</p>
|
|
<p>The parameter <code>idx</code> is passed in on an <a class="el" href="group___h5_a.html#ga9315a22b60468b6e996559b1b8a77251" title="Calls a user-defined function for each attribute on an object.">H5Aiterate2()</a> call with one value and may be returned with another value. The value passed in identifies the parameter to be operated on first; the value returned identifies the parameter to be operated on in the next step of the iteration.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is also available through the <a class="el" href="group___h5_a.html#gab9dcfc543cd4282f32b8ea19e08ffa6c">H5Aiterate()</a> macro.</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Adding or removing attributes to the object during iteration will lead to undefined behavior.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga75db973d69b61f673f5cdf21ac624cef" name="ga75db973d69b61f673f5cdf21ac624cef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga75db973d69b61f673f5cdf21ac624cef">◆ </a></span>H5Aiterate_by_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Aiterate_by_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> </td>
|
|
<td class="paramname"><em>idx_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> </td>
|
|
<td class="paramname"><em>order</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td>
|
|
<td class="paramname"><em>idx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_apublic_8h.html#a28fef0ded9a6c0eb12334c0d15dc3e74">H5A_operator2_t</a> </td>
|
|
<td class="paramname"><em>op</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>op_data</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calls user-defined function for each attribute on an object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name of object, relative to location </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Type of index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Order in which to iterate over index </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Initial and returned offset within index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>User-defined function to pass each attribute to </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">op_data</td><td>User data to pass through to and to be returned by iterator operator function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value. Further note that this function returns the return value of the last operator if it is non-zero, which can be a negative value, zero if all attributes were processed, or a positive value indicating short-circuit success.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga75db973d69b61f673f5cdf21ac624cef" title="Calls user-defined function for each attribute on an object.">H5Aiterate_by_name()</a> iterates over the attributes attached to the dataset or group specified with <code>loc_id</code> and <code>obj_name</code>. For each attribute, user-provided data, <code>op_data</code>, with additional information, as defined below, is passed to a user-defined function, <code>op</code>, which operates on that attribute.</p>
|
|
<p>The order of the iteration and the attributes iterated over are specified by three parameters: the index type, <code>idx_type</code>; the order in which the index is to be traversed, <code>order</code>; and the attribute's position in the index, <code>idx</code>. The next attribute to be operated on is specified by <code>idx</code>, a position in the index.</p>
|
|
<p>For example, if <code>idx_type</code>, <code>order</code>, and <code>idx</code> are set to <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a>, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a>, and 5, respectively, the attribute in question is the fifth attribute from the beginning of the alphanumeric index of attribute names. If <code>order</code> were set to <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a>, it would be the fifth attribute from the end of the index.</p>
|
|
<p>The parameter <code>idx</code> is passed in on an <a class="el" href="group___h5_a.html#ga75db973d69b61f673f5cdf21ac624cef" title="Calls user-defined function for each attribute on an object.">H5Aiterate_by_name()</a> call with one value and may be returned with another value. The value passed in identifies the parameter to be operated on first; the value returned identifies the parameter to be operated on in the next step of the iteration.</p>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Adding or removing attributes to the object during iteration will lead to undefined behavior.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga59863b205b6d93b2145f0fbca49656f7" name="ga59863b205b6d93b2145f0fbca49656f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga59863b205b6d93b2145f0fbca49656f7">◆ </a></span>H5Aopen()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Aopen </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>obj_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attr_name</em>, </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"><em>aapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens an attribute for an object specified by object identifier and attribute name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Name of attribute to open </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">aapl_id</td><td>Attribute access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7" title="Opens an attribute for an object specified by object identifier and attribute name.">H5Aopen()</a> opens an existing attribute, <code>attr_name</code>, that is attached to the object specified by an object identifier, <code>obj_id</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The <code>aapl_id</code> parameter is currently not used; specify <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</dd></dl>
|
|
<p>This function, <a class="el" href="group___h5_a.html#gab1451cdff4f77dcf9feaee83c8179b2d" title="Opens the nth attribute attached to an object.">H5Aopen_by_idx()</a> or <a class="el" href="group___h5_a.html#gadb49a0b5b9798d2e944d877adba8ae10" title="Opens an attribute for an object by object name and attribute name.">H5Aopen_by_name()</a> must be called before the attribute can be accessed for any further purpose, including reading, writing, or any modification.</p>
|
|
<p>The attribute identifier returned by this function must be released with <a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> or resource leaks will develop.</p>
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div>
|
|
<div class="line"> __label__ fail_attr, fail_file;</div>
|
|
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, attr;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code hl_define" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> file_name[] = <span class="stringliteral">"f1.h5"</span>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> attr_name[] = <span class="stringliteral">"Χαρακτηριστικό"</span>;</div>
|
|
<div class="line"> <span class="keywordtype">int</span> value;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(file_name, mode, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_file;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((attr = <a class="code hl_function" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7">H5Aopen</a>(file, attr_name, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_attr;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// read the attribute value</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___h5_a.html#gaacb27a997f7c98e8a833d0fd63b58f1c">H5Aread</a>(attr, <a class="code hl_define" href="group___p_d_t_n_a_t.html#ga3cf93ffc6782be68070ef8e00f219ec2">H5T_NATIVE_INT</a>, &value) < 0)</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// do something w/ the attribute value</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda">H5Aclose</a>(attr);</div>
|
|
<div class="line">fail_attr:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
|
|
<div class="line">fail_file:;</div>
|
|
<div class="line"> }</div>
|
|
<div class="ttc" id="a_h5_fpublic_8h_html_a1c406ffa89f4acf5a332144a2683d394"><div class="ttname"><a href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a></div><div class="ttdeci">#define H5F_ACC_RDONLY</div><div class="ttdef"><b>Definition</b> H5Fpublic.h:48</div></div>
|
|
<div class="ttc" id="agroup___h5_a_html_ga59863b205b6d93b2145f0fbca49656f7"><div class="ttname"><a href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7">H5Aopen</a></div><div class="ttdeci">hid_t H5Aopen(hid_t obj_id, const char *attr_name, hid_t aapl_id)</div><div class="ttdoc">Opens an attribute for an object specified by object identifier and attribute name.</div></div>
|
|
<div class="ttc" id="agroup___h5_a_html_gaacb27a997f7c98e8a833d0fd63b58f1c"><div class="ttname"><a href="group___h5_a.html#gaacb27a997f7c98e8a833d0fd63b58f1c">H5Aread</a></div><div class="ttdeci">herr_t H5Aread(hid_t attr_id, hid_t type_id, void *buf)</div><div class="ttdoc">Reads the value of an attribute.</div></div>
|
|
<div class="ttc" id="agroup___p_d_t_n_a_t_html_ga3cf93ffc6782be68070ef8e00f219ec2"><div class="ttname"><a href="group___p_d_t_n_a_t.html#ga3cf93ffc6782be68070ef8e00f219ec2">H5T_NATIVE_INT</a></div><div class="ttdeci">#define H5T_NATIVE_INT</div><div class="ttdef"><b>Definition</b> H5Tpublic.h:780</div></div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a>, <a class="el" href="group___h5_a.html#ga4a76e4e5ab6eb0fd2aa7990d38d55f24">H5Acreate()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab1451cdff4f77dcf9feaee83c8179b2d" name="gab1451cdff4f77dcf9feaee83c8179b2d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab1451cdff4f77dcf9feaee83c8179b2d">◆ </a></span>H5Aopen_by_idx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Aopen_by_idx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> </td>
|
|
<td class="paramname"><em>idx_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> </td>
|
|
<td class="paramname"><em>order</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>n</em>, </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"><em>aapl_id</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens the nth attribute attached to an object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name of object to which attribute is attached, relative to location </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Type of index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Index traversal order </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Attribute's position in index </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">aapl_id</td><td>Attribute access property list identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gab1451cdff4f77dcf9feaee83c8179b2d" title="Opens the nth attribute attached to an object.">H5Aopen_by_idx()</a> opens an existing attribute that is attached to an object specified by location and name, <code>loc_id</code> and <code>obj_name</code>, respectively.</p>
|
|
<p>The attribute is identified by an index type, an index traversal order, and a position in the index, <code>idx_type</code>, <code>order</code> and <code>n</code>, respectively.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The <code>aapl_id</code> parameter is currently not used; specify <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</dd></dl>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<p>This function, <a class="el" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7" title="Opens an attribute for an object specified by object identifier and attribute name.">H5Aopen()</a>, or <a class="el" href="group___h5_a.html#gadb49a0b5b9798d2e944d877adba8ae10" title="Opens an attribute for an object by object name and attribute name.">H5Aopen_by_name()</a> must be called before an attribute can be accessed for any further purpose, including reading, writing, or any modification.</p>
|
|
<p>The attribute identifier returned by this function must be released with <a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> or resource leaks will develop.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadb49a0b5b9798d2e944d877adba8ae10" name="gadb49a0b5b9798d2e944d877adba8ae10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadb49a0b5b9798d2e944d877adba8ae10">◆ </a></span>H5Aopen_by_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Aopen_by_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attr_name</em>, </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"><em>aapl_id</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens an attribute for an object by object name and attribute name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name of object to which attribute is attached, relative to <code>loc_id</code> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Name of attribute to open </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">aapl_id</td><td>Attribute access property list identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gadb49a0b5b9798d2e944d877adba8ae10" title="Opens an attribute for an object by object name and attribute name.">H5Aopen_by_name()</a> opens an existing attribute, <code>attr_name</code>, that is attached to an object specified by location and name, <code>loc_id</code> and <code>obj_name</code>, respectively.</p>
|
|
<p><code>loc_id</code> specifies a location from which the target object can be located and <code>obj_name</code> is an object name relative to <code>loc_id</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The <code>aapl_id</code> parameter is currently not used; specify <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</dd></dl>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<p>This function, <a class="el" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7" title="Opens an attribute for an object specified by object identifier and attribute name.">H5Aopen()</a>, or <a class="el" href="group___h5_a.html#gab1451cdff4f77dcf9feaee83c8179b2d" title="Opens the nth attribute attached to an object.">H5Aopen_by_idx()</a> must be called before an attribute can be accessed for any further purpose, including reading, writing, or any modification.</p>
|
|
<p>The attribute identifier returned by this function must be released with <a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> or resource leaks will develop.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadaa85276f2731ad78462a6fd27118470" name="gadaa85276f2731ad78462a6fd27118470"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadaa85276f2731ad78462a6fd27118470">◆ </a></span>H5Aopen_idx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Aopen_idx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"><em>idx</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens the attribute specified by its index. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>Index of the attribute to open</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>Superseded by <a class="el" href="group___h5_a.html#gab1451cdff4f77dcf9feaee83c8179b2d" title="Opens the nth attribute attached to an object.">H5Aopen_by_idx()</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#gadaa85276f2731ad78462a6fd27118470" title="Opens the attribute specified by its index.">H5Aopen_idx()</a> opens an attribute that is attached to the object specified with <code>loc_id</code>. The location object may be either a group, dataset, or named datatype, all of which may have any sort of attribute. The attribute specified by the index, <code>idx</code>, indicates the attribute to access. The value of <code>idx</code> is a 0-based, non-negative integer. The attribute identifier returned from this function must be released with <a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> or resource leaks will develop.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5c05fade96b6b7e2299f56a5b1edb1c1" name="ga5c05fade96b6b7e2299f56a5b1edb1c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5c05fade96b6b7e2299f56a5b1edb1c1">◆ </a></span>H5Aopen_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Aopen_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens an attribute specified by name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Attribute name</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns an attribute identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>Superseded by <a class="el" href="group___h5_a.html#gadb49a0b5b9798d2e944d877adba8ae10" title="Opens an attribute for an object by object name and attribute name.">H5Aopen_by_name()</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_a.html#ga5c05fade96b6b7e2299f56a5b1edb1c1" title="Opens an attribute specified by name.">H5Aopen_name()</a> opens an attribute specified by its name, <code>name</code>, which is attached to the object specified with <code>loc_id</code>. The location object may be either a group, dataset, or named datatype, which may have any sort of attribute. The attribute identifier returned from this function must be released with <a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> or resource leaks will develop.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaacb27a997f7c98e8a833d0fd63b58f1c" name="gaacb27a997f7c98e8a833d0fd63b58f1c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaacb27a997f7c98e8a833d0fd63b58f1c">◆ </a></span>H5Aread()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Aread </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>attr_id</em>, </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"><em>type_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buf</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the value of an attribute. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_id</td><td>Attribute identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype (in-memory) identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer for data to be read</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="group___h5_a.html#gaacb27a997f7c98e8a833d0fd63b58f1c" title="Reads the value of an attribute.">H5Aread()</a> reads an attribute, specified with <code>attr_id</code>. The attribute's in-memory datatype is specified with <code>type_id</code>. The entire attribute is read into <code>buf</code> from the file.</p>
|
|
<p>Datatype conversion takes place at the time of a read or write and is automatic.</p>
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div>
|
|
<div class="line"> __label__ fail_attr, fail_file;</div>
|
|
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, attr;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code hl_define" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> file_name[] = <span class="stringliteral">"f1.h5"</span>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> attr_name[] = <span class="stringliteral">"Χαρακτηριστικό"</span>;</div>
|
|
<div class="line"> <span class="keywordtype">int</span> value;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(file_name, mode, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_file;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((attr = <a class="code hl_function" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7">H5Aopen</a>(file, attr_name, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_attr;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// read the attribute value</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___h5_a.html#gaacb27a997f7c98e8a833d0fd63b58f1c">H5Aread</a>(attr, <a class="code hl_define" href="group___p_d_t_n_a_t.html#ga3cf93ffc6782be68070ef8e00f219ec2">H5T_NATIVE_INT</a>, &value) < 0)</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// do something w/ the attribute value</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda">H5Aclose</a>(attr);</div>
|
|
<div class="line">fail_attr:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
|
|
<div class="line">fail_file:;</div>
|
|
<div class="line"> }</div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>1.8.8 Fortran updated to Fortran2003. </dd>
|
|
<dd>
|
|
1.4.2 The <code>dims</code> parameter was added to the Fortran API in this release. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_a.html#gab70871e205d57450c83efd9912be2b5c" title="Writes data to an attribute.">H5Awrite()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga490dcd6db246c1fda7295badfce28203" name="ga490dcd6db246c1fda7295badfce28203"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga490dcd6db246c1fda7295badfce28203">◆ </a></span>H5Arename()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Arename </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>old_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>new_name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Renames an attribute. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">old_name</td><td>Name of the attribute to be changed </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">new_name</td><td>New name for the attribute</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="group___h5_a.html#ga490dcd6db246c1fda7295badfce28203" title="Renames an attribute.">H5Arename()</a> changes the name of the attribute located at <code>loc_id</code>.</p>
|
|
<p>The old name, <code>old_name</code>, is changed to the new name, <code>new_name</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga21f8483c935d72187b98f5e7c2056140" name="ga21f8483c935d72187b98f5e7c2056140"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga21f8483c935d72187b98f5e7c2056140">◆ </a></span>H5Arename_by_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Arename_by_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>loc_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>old_attr_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>new_attr_name</em>, </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"><em>lapl_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Name of object, relative to location, whose attribute is to be renamed </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">old_attr_name</td><td>Prior attribute name </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">new_attr_name</td><td>New attribute name </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p><a class="el" href="group___h5_a.html#ga21f8483c935d72187b98f5e7c2056140">H5Arename_by_name()</a> changes the name of attribute that is attached to the object specified by <code>loc_id</code> and <code>obj_name</code>. The attribute named <code>old_attr_name</code> is renamed <code>new_attr_name</code>.</p>
|
|
<p>The link access property list, <code>lapl_id</code>, may provide information regarding the properties of links required to access the object, <code>obj_name</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab70871e205d57450c83efd9912be2b5c" name="gab70871e205d57450c83efd9912be2b5c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab70871e205d57450c83efd9912be2b5c">◆ </a></span>H5Awrite()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Awrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>attr_id</em>, </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"><em>type_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>buf</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Writes data to an attribute. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">attr_id</td><td>Attribute identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype (in-memory) identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Data to be written</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="group___h5_a.html#gab70871e205d57450c83efd9912be2b5c" title="Writes data to an attribute.">H5Awrite()</a> writes an attribute, specified with <code>attr_id</code>. The attribute's in-memory datatype is specified with <code>type_id</code>. The entire attribute is written from <code>buf</code> to the file.</p>
|
|
<p>Datatype conversion takes place at the time of a read or write and is automatic.</p>
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div>
|
|
<div class="line"> __label__ fail_attr, fail_file;</div>
|
|
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, attr;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code hl_define" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> file_name[] = <span class="stringliteral">"f1.h5"</span>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> attr_name[] = <span class="stringliteral">"Χαρακτηριστικό"</span>;</div>
|
|
<div class="line"> <span class="keywordtype">int</span> value = 1234;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(file_name, mode, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_file;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((attr = <a class="code hl_function" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7">H5Aopen</a>(file, attr_name, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_attr;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// update the attribute value</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___h5_a.html#gab70871e205d57450c83efd9912be2b5c">H5Awrite</a>(attr, <a class="code hl_define" href="group___p_d_t_n_a_t.html#ga3cf93ffc6782be68070ef8e00f219ec2">H5T_NATIVE_INT</a>, &value) < 0)</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda">H5Aclose</a>(attr);</div>
|
|
<div class="line">fail_attr:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
|
|
<div class="line">fail_file:;</div>
|
|
<div class="line"> }</div>
|
|
<div class="ttc" id="agroup___h5_a_html_gab70871e205d57450c83efd9912be2b5c"><div class="ttname"><a href="group___h5_a.html#gab70871e205d57450c83efd9912be2b5c">H5Awrite</a></div><div class="ttdeci">herr_t H5Awrite(hid_t attr_id, hid_t type_id, const void *buf)</div><div class="ttdoc">Writes data to an attribute.</div></div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>1.8.8 Fortran updated to Fortran2003. </dd>
|
|
<dd>
|
|
1.4.2 Fortran <code>dims</code> parameter added in this release </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_a.html#gaacb27a997f7c98e8a833d0fd63b58f1c" title="Reads the value of an attribute.">H5Aread()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.7 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|