mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
2015 lines
112 KiB
HTML
2015 lines
112 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.16.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>HDF5: Fortran Group (H5G) Interface</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
|
|
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
|
|
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Help us improve by taking our short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
|
|
<!-- ... other metadata & script includes ... -->
|
|
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeTabs.init()
|
|
</script>
|
|
<!-- Google tag (gtag.js) -->
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-57FMZK4S7X"></script>
|
|
<script>
|
|
window.dataLayer = window.dataLayer || [];
|
|
function gtag(){dataLayer.push(arguments);}
|
|
gtag('js', new Date());
|
|
gtag('config', 'G-57FMZK4S7X');
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">HDF5<span id="projectnumber"> Last Updated on 2026-09-02</span>
|
|
</div>
|
|
<div id="projectbrief">The HDF5 Field Guide</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.16.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<div id="main-nav">
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main 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="_f_t_s.html"><span>Full-Text Search</span></a></li>
|
|
<li><a href="_about.html"><span>About</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- main-nav -->
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(function(){initNavTree('group___f_h5_g.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">Fortran Group (H5G) Interface </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_g.html">Groups (H5G)</a>, C-API</dd>
|
|
<dd>
|
|
<a class="el" href="_h5_g__u_g.html" title="HDF5 Groups">HDF5 Groups</a>, User Guide </dd></dl>
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-namespaces" class="groupheader"><a id="namespaces" name="namespaces"></a>
|
|
Modules</h2></td></tr>
|
|
<tr class="memitem:h5g" id="r_h5g"><td class="memItemLeft">module  </td><td class="memItemRight"><a class="el" href="namespaceh5g.html">h5g</a></td></tr>
|
|
<tr class="memdesc:namespaceh5g"><td class="mdescLeft"> </td><td class="mdescRight">This module contains Fortran interfaces for H5G functions. <br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions/Subroutines</h2></td></tr>
|
|
<tr class="memitem:ga0f1fca071acf843a8f0f14ace360da30" id="r_ga0f1fca071acf843a8f0f14ace360da30"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga0f1fca071acf843a8f0f14ace360da30">h5gclose_async_f</a> (grp_id, es_id, hdferr, file, func, line)</td></tr>
|
|
<tr class="memdesc:ga0f1fca071acf843a8f0f14ace360da30"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously closes the specified group. <br /></td></tr>
|
|
<tr class="memitem:ga73669a0bfa54f59d82faffaf0ca70e24" id="r_ga73669a0bfa54f59d82faffaf0ca70e24"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga73669a0bfa54f59d82faffaf0ca70e24">h5gclose_f</a> (grp_id, hdferr)</td></tr>
|
|
<tr class="memdesc:ga73669a0bfa54f59d82faffaf0ca70e24"><td class="mdescLeft"> </td><td class="mdescRight">Closes the specified group. <br /></td></tr>
|
|
<tr class="memitem:gad6f5a657141854976db7d3626e46d65f" id="r_gad6f5a657141854976db7d3626e46d65f"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#gad6f5a657141854976db7d3626e46d65f">h5gcreate_anon_f</a> (loc_id, grp_id, hdferr, gcpl_id, gapl_id)</td></tr>
|
|
<tr class="memdesc:gad6f5a657141854976db7d3626e46d65f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new empty group without linking it into the file structure. <br /></td></tr>
|
|
<tr class="memitem:ga8b7f6461c9790610bead7641385e3846" id="r_ga8b7f6461c9790610bead7641385e3846"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga8b7f6461c9790610bead7641385e3846">h5gcreate_async_f</a> (loc_id, name, grp_id, es_id, hdferr, size_hint, lcpl_id, gcpl_id, gapl_id, file, func, line)</td></tr>
|
|
<tr class="memdesc:ga8b7f6461c9790610bead7641385e3846"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously creates a new group. <br /></td></tr>
|
|
<tr class="memitem:ga46671f95224d65f76bd160172d780b5f" id="r_ga46671f95224d65f76bd160172d780b5f"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga46671f95224d65f76bd160172d780b5f">h5gcreate_f</a> (loc_id, name, grp_id, hdferr, size_hint, lcpl_id, gcpl_id, gapl_id)</td></tr>
|
|
<tr class="memdesc:ga46671f95224d65f76bd160172d780b5f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new group. <br /></td></tr>
|
|
<tr class="memitem:ga8df2de290bddd8a4baf019fb5f687354" id="r_ga8df2de290bddd8a4baf019fb5f687354"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga8df2de290bddd8a4baf019fb5f687354">h5gget_comment_f</a> (loc_id, name, size, buffer, hdferr)</td></tr>
|
|
<tr class="memdesc:ga8df2de290bddd8a4baf019fb5f687354"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves comment for specified object. <br /></td></tr>
|
|
<tr class="memitem:gacba3215c2be6f7613f18bd5a3238628c" id="r_gacba3215c2be6f7613f18bd5a3238628c"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#gacba3215c2be6f7613f18bd5a3238628c">h5gget_create_plist_f</a> (grp_id, gcpl_id, hdferr)</td></tr>
|
|
<tr class="memdesc:gacba3215c2be6f7613f18bd5a3238628c"><td class="mdescLeft"> </td><td class="mdescRight">Gets a group creation property list identifier. <br /></td></tr>
|
|
<tr class="memitem:ga64432a92565ce151feb6a09881612952" id="r_ga64432a92565ce151feb6a09881612952"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga64432a92565ce151feb6a09881612952">h5gget_info_async_f</a> (loc_id, ginfo, es_id, hdferr, file, func, line)</td></tr>
|
|
<tr class="memdesc:ga64432a92565ce151feb6a09881612952"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously retrieves information about a group. <br /></td></tr>
|
|
<tr class="memitem:ga8cf41f98e451da9eb02e364de4fc956a" id="r_ga8cf41f98e451da9eb02e364de4fc956a"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga8cf41f98e451da9eb02e364de4fc956a">h5gget_info_by_idx_async_f</a> (loc_id, group_name, idx_type, order, n, ginfo, es_id, hdferr, lapl_id, file, func, line)</td></tr>
|
|
<tr class="memdesc:ga8cf41f98e451da9eb02e364de4fc956a"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously retrieves information about a group, according to the group's position within an index. <br /></td></tr>
|
|
<tr class="memitem:ga11c96cfd376734b5c32b021b2321cf65" id="r_ga11c96cfd376734b5c32b021b2321cf65"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga11c96cfd376734b5c32b021b2321cf65">h5gget_info_by_idx_f</a> (loc_id, group_name, idx_type, order, n, ginfo, hdferr, lapl_id)</td></tr>
|
|
<tr class="memdesc:ga11c96cfd376734b5c32b021b2321cf65"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a group, according to the group's position within an index. <br /></td></tr>
|
|
<tr class="memitem:ga12ee3ea31500e465f74e762f5f01119b" id="r_ga12ee3ea31500e465f74e762f5f01119b"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga12ee3ea31500e465f74e762f5f01119b">h5gget_info_by_idx_f</a> (loc_id, group_name, idx_type, order, n, storage_type, nlinks, max_corder, hdferr, lapl_id, mounted)</td></tr>
|
|
<tr class="memdesc:ga12ee3ea31500e465f74e762f5f01119b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a group, according to the group's position within an index. <br /></td></tr>
|
|
<tr class="memitem:gae7634ace200b31764d67867f9b02d0fd" id="r_gae7634ace200b31764d67867f9b02d0fd"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#gae7634ace200b31764d67867f9b02d0fd">h5gget_info_by_name_async_f</a> (loc_id, name, ginfo, es_id, hdferr, lapl_id, file, func, line)</td></tr>
|
|
<tr class="memdesc:gae7634ace200b31764d67867f9b02d0fd"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously retrieves information about a group by its name. <br /></td></tr>
|
|
<tr class="memitem:ga2f07d9a9eea89d2a9b4be58bb4bb5bea" id="r_ga2f07d9a9eea89d2a9b4be58bb4bb5bea"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga2f07d9a9eea89d2a9b4be58bb4bb5bea">h5gget_info_by_name_f</a> (loc_id, name, ginfo, hdferr, lapl_id)</td></tr>
|
|
<tr class="memdesc:ga2f07d9a9eea89d2a9b4be58bb4bb5bea"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a group by its name. <br /></td></tr>
|
|
<tr class="memitem:ga91d7a8a2f0d027a68670091f2922d5db" id="r_ga91d7a8a2f0d027a68670091f2922d5db"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga91d7a8a2f0d027a68670091f2922d5db">h5gget_info_by_name_f</a> (loc_id, name, storage_type, nlinks, max_corder, hdferr, lapl_id, mounted)</td></tr>
|
|
<tr class="memdesc:ga91d7a8a2f0d027a68670091f2922d5db"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a group by its name. <br /></td></tr>
|
|
<tr class="memitem:ga342819ce799f2124195507d73f359e81" id="r_ga342819ce799f2124195507d73f359e81"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga342819ce799f2124195507d73f359e81">h5gget_info_f</a> (loc_id, ginfo, hdferr)</td></tr>
|
|
<tr class="memdesc:ga342819ce799f2124195507d73f359e81"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a group. <br /></td></tr>
|
|
<tr class="memitem:gab33eace70c2d660bf41508cd82fd14a5" id="r_gab33eace70c2d660bf41508cd82fd14a5"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#gab33eace70c2d660bf41508cd82fd14a5">h5gget_info_f</a> (loc_id, storage_type, nlinks, max_corder, hdferr, mounted)</td></tr>
|
|
<tr class="memdesc:gab33eace70c2d660bf41508cd82fd14a5"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a group. <br /></td></tr>
|
|
<tr class="memitem:ga27e2caf17b1150077d73fe0eeec001ae" id="r_ga27e2caf17b1150077d73fe0eeec001ae"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga27e2caf17b1150077d73fe0eeec001ae">h5gget_linkval_f</a> (loc_id, name, size, buffer, hdferr)</td></tr>
|
|
<tr class="memdesc:ga27e2caf17b1150077d73fe0eeec001ae"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the object that the symbolic link points to. <br /></td></tr>
|
|
<tr class="memitem:ga6116470c2445a092063531fe66caf7a6" id="r_ga6116470c2445a092063531fe66caf7a6"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga6116470c2445a092063531fe66caf7a6">h5gget_obj_info_idx_f</a> (loc_id, name, idx, obj_name, obj_type, hdferr)</td></tr>
|
|
<tr class="memdesc:ga6116470c2445a092063531fe66caf7a6"><td class="mdescLeft"> </td><td class="mdescRight">Returns name and type of the group member identified by its index. <br /></td></tr>
|
|
<tr class="memitem:gac81976336d2bdaebd4cb61c1a6b57955" id="r_gac81976336d2bdaebd4cb61c1a6b57955"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#gac81976336d2bdaebd4cb61c1a6b57955">h5glink2_f</a> (cur_loc_id, cur_name, link_type, new_loc_id, new_name, hdferr)</td></tr>
|
|
<tr class="memdesc:gac81976336d2bdaebd4cb61c1a6b57955"><td class="mdescLeft"> </td><td class="mdescRight">Creates a link of the specified type from new_name to current_name. current_name and new_name are interpreted relative to current and new location identifiers. <br /></td></tr>
|
|
<tr class="memitem:gaae1f4d458c2ff152d9af0712fc5a02ec" id="r_gaae1f4d458c2ff152d9af0712fc5a02ec"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#gaae1f4d458c2ff152d9af0712fc5a02ec">h5glink_f</a> (loc_id, link_type, current_name, new_name, hdferr)</td></tr>
|
|
<tr class="memdesc:gaae1f4d458c2ff152d9af0712fc5a02ec"><td class="mdescLeft"> </td><td class="mdescRight">Creates a link of the specified type from new_name to current_name. <br /></td></tr>
|
|
<tr class="memitem:ga3691ae6c786a83cf37605a4a9573775b" id="r_ga3691ae6c786a83cf37605a4a9573775b"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga3691ae6c786a83cf37605a4a9573775b">h5gmove2_f</a> (src_loc_id, src_name, dst_loc_id, dst_name, hdferr)</td></tr>
|
|
<tr class="memdesc:ga3691ae6c786a83cf37605a4a9573775b"><td class="mdescLeft"> </td><td class="mdescRight">Renames an object within an HDF5 file. <br /></td></tr>
|
|
<tr class="memitem:ga01f3177b62f15e3e79f6eaf34fb62e05" id="r_ga01f3177b62f15e3e79f6eaf34fb62e05"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga01f3177b62f15e3e79f6eaf34fb62e05">h5gmove_f</a> (loc_id, name, new_name, hdferr)</td></tr>
|
|
<tr class="memdesc:ga01f3177b62f15e3e79f6eaf34fb62e05"><td class="mdescLeft"> </td><td class="mdescRight">Renames an object within an HDF5 file. <br /></td></tr>
|
|
<tr class="memitem:ga40d5ac9dabbc09716a43f79578bad04d" id="r_ga40d5ac9dabbc09716a43f79578bad04d"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga40d5ac9dabbc09716a43f79578bad04d">h5gn_members_f</a> (loc_id, name, nmembers, hdferr)</td></tr>
|
|
<tr class="memdesc:ga40d5ac9dabbc09716a43f79578bad04d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of group members. <br /></td></tr>
|
|
<tr class="memitem:gad9fe7e599935454227309bdaeb163b21" id="r_gad9fe7e599935454227309bdaeb163b21"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#gad9fe7e599935454227309bdaeb163b21">h5gopen_async_f</a> (loc_id, name, grp_id, es_id, hdferr, gapl_id, file, func, line)</td></tr>
|
|
<tr class="memdesc:gad9fe7e599935454227309bdaeb163b21"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously opens an existing group. <br /></td></tr>
|
|
<tr class="memitem:ga1ef9a46fd72dd543eeabf9fc33a5fe63" id="r_ga1ef9a46fd72dd543eeabf9fc33a5fe63"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga1ef9a46fd72dd543eeabf9fc33a5fe63">h5gopen_f</a> (loc_id, name, grp_id, hdferr, gapl_id)</td></tr>
|
|
<tr class="memdesc:ga1ef9a46fd72dd543eeabf9fc33a5fe63"><td class="mdescLeft"> </td><td class="mdescRight">Opens an existing group. <br /></td></tr>
|
|
<tr class="memitem:gaf5e8a26b2b946bf75e08d1e7fd9a58dd" id="r_gaf5e8a26b2b946bf75e08d1e7fd9a58dd"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#gaf5e8a26b2b946bf75e08d1e7fd9a58dd">h5gset_comment_f</a> (loc_id, name, comment, hdferr)</td></tr>
|
|
<tr class="memdesc:gaf5e8a26b2b946bf75e08d1e7fd9a58dd"><td class="mdescLeft"> </td><td class="mdescRight">Sets comment for specified object. <br /></td></tr>
|
|
<tr class="memitem:ga0f91bf4cf51439c7d9f2994e809b7322" id="r_ga0f91bf4cf51439c7d9f2994e809b7322"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="#ga0f91bf4cf51439c7d9f2994e809b7322">h5gunlink_f</a> (loc_id, name, hdferr)</td></tr>
|
|
<tr class="memdesc:ga0f91bf4cf51439c7d9f2994e809b7322"><td class="mdescLeft"> </td><td class="mdescRight">Removes the specified name from the group graph and decrements the link count for the object to which name points. <br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-var-members" class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:ga2508046cee8c9071688f4beab505ec49" id="r_ga2508046cee8c9071688f4beab505ec49"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga2508046cee8c9071688f4beab505ec49">h5g_dataset_f</a></td></tr>
|
|
<tr class="memdesc:ga2508046cee8c9071688f4beab505ec49"><td class="mdescLeft"> </td><td class="mdescRight">H5G_DATASET. <br /></td></tr>
|
|
<tr class="memitem:ga37730c4224493dc435a96aeed68071f3" id="r_ga37730c4224493dc435a96aeed68071f3"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga37730c4224493dc435a96aeed68071f3">h5g_group_f</a></td></tr>
|
|
<tr class="memdesc:ga37730c4224493dc435a96aeed68071f3"><td class="mdescLeft"> </td><td class="mdescRight">H5G_GROUP. <br /></td></tr>
|
|
<tr class="memitem:ga30653bcf0fcfb996b3df97bbb7bc5a20" id="r_ga30653bcf0fcfb996b3df97bbb7bc5a20"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga30653bcf0fcfb996b3df97bbb7bc5a20">h5g_link_error_f</a></td></tr>
|
|
<tr class="memdesc:ga30653bcf0fcfb996b3df97bbb7bc5a20"><td class="mdescLeft"> </td><td class="mdescRight">H5G_LINK_ERROR. <br /></td></tr>
|
|
<tr class="memitem:ga88b294a23d435761acc3eceaedc2dfe0" id="r_ga88b294a23d435761acc3eceaedc2dfe0"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga88b294a23d435761acc3eceaedc2dfe0">h5g_link_f</a></td></tr>
|
|
<tr class="memdesc:ga88b294a23d435761acc3eceaedc2dfe0"><td class="mdescLeft"> </td><td class="mdescRight">H5G_LINK. <br /></td></tr>
|
|
<tr class="memitem:gabfbff6eef1d9d1e4553fac89bed7382e" id="r_gabfbff6eef1d9d1e4553fac89bed7382e"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#gabfbff6eef1d9d1e4553fac89bed7382e">h5g_link_hard_f</a></td></tr>
|
|
<tr class="memdesc:gabfbff6eef1d9d1e4553fac89bed7382e"><td class="mdescLeft"> </td><td class="mdescRight">H5G_LINK_HARD. <br /></td></tr>
|
|
<tr class="memitem:ga94af2f0ea4eac5e167b3cdcb88dc0544" id="r_ga94af2f0ea4eac5e167b3cdcb88dc0544"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga94af2f0ea4eac5e167b3cdcb88dc0544">h5g_link_soft_f</a></td></tr>
|
|
<tr class="memdesc:ga94af2f0ea4eac5e167b3cdcb88dc0544"><td class="mdescLeft"> </td><td class="mdescRight">H5G_LINK_SOFT. <br /></td></tr>
|
|
<tr class="memitem:ga6d1fad1141975d70db7610fabde9e26a" id="r_ga6d1fad1141975d70db7610fabde9e26a"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga6d1fad1141975d70db7610fabde9e26a">h5g_same_loc_f</a></td></tr>
|
|
<tr class="memdesc:ga6d1fad1141975d70db7610fabde9e26a"><td class="mdescLeft"> </td><td class="mdescRight">H5G_SAME_LOC. <br /></td></tr>
|
|
<tr class="memitem:ga8bb2e9737aa90960668e27f7310f101a" id="r_ga8bb2e9737aa90960668e27f7310f101a"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga8bb2e9737aa90960668e27f7310f101a">h5g_storage_type_compact_f</a></td></tr>
|
|
<tr class="memdesc:ga8bb2e9737aa90960668e27f7310f101a"><td class="mdescLeft"> </td><td class="mdescRight">H5G_STORAGE_TYPE_COMPACT. <br /></td></tr>
|
|
<tr class="memitem:ga876361ba67a36f2901eb49972c457917" id="r_ga876361ba67a36f2901eb49972c457917"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga876361ba67a36f2901eb49972c457917">h5g_storage_type_dense_f</a></td></tr>
|
|
<tr class="memdesc:ga876361ba67a36f2901eb49972c457917"><td class="mdescLeft"> </td><td class="mdescRight">H5G_STORAGE_TYPE_DENSE. <br /></td></tr>
|
|
<tr class="memitem:gaf5e1c293b9d50c3f5d4f7f98682f5c0a" id="r_gaf5e1c293b9d50c3f5d4f7f98682f5c0a"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#gaf5e1c293b9d50c3f5d4f7f98682f5c0a">h5g_storage_type_symbol_table_f</a></td></tr>
|
|
<tr class="memdesc:gaf5e1c293b9d50c3f5d4f7f98682f5c0a"><td class="mdescLeft"> </td><td class="mdescRight">H5G_STORAGE_TYPE_SYMBOL_TABLE. <br /></td></tr>
|
|
<tr class="memitem:ga5efe327155edcd2eea9b7084cd807601" id="r_ga5efe327155edcd2eea9b7084cd807601"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga5efe327155edcd2eea9b7084cd807601">h5g_storage_type_unknown_f</a></td></tr>
|
|
<tr class="memdesc:ga5efe327155edcd2eea9b7084cd807601"><td class="mdescLeft"> </td><td class="mdescRight">H5G_STORAGE_TYPE_UNKNOWN. <br /></td></tr>
|
|
<tr class="memitem:ga3d128641813ad9ec6ef6c6a5db17df0b" id="r_ga3d128641813ad9ec6ef6c6a5db17df0b"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga3d128641813ad9ec6ef6c6a5db17df0b">h5g_type_f</a></td></tr>
|
|
<tr class="memdesc:ga3d128641813ad9ec6ef6c6a5db17df0b"><td class="mdescLeft"> </td><td class="mdescRight">H5G_TYPE. <br /></td></tr>
|
|
<tr class="memitem:ga5b48366c7e731f5d81399f0304e0efaa" id="r_ga5b48366c7e731f5d81399f0304e0efaa"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga5b48366c7e731f5d81399f0304e0efaa">h5g_udlink_f</a></td></tr>
|
|
<tr class="memdesc:ga5b48366c7e731f5d81399f0304e0efaa"><td class="mdescLeft"> </td><td class="mdescRight">H5G_UDLINK. <br /></td></tr>
|
|
<tr class="memitem:ga8aa3fccdcdca39b9ea82068e10c283a8" id="r_ga8aa3fccdcdca39b9ea82068e10c283a8"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#ga8aa3fccdcdca39b9ea82068e10c283a8">h5g_unknown_f</a></td></tr>
|
|
<tr class="memdesc:ga8aa3fccdcdca39b9ea82068e10c283a8"><td class="mdescLeft"> </td><td class="mdescRight">H5G_UNKNOWN. <br /></td></tr>
|
|
</table>
|
|
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function/Subroutine Documentation</h2>
|
|
<a id="ga0f1fca071acf843a8f0f14ace360da30" name="ga0f1fca071acf843a8f0f14ace360da30"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0f1fca071acf843a8f0f14ace360da30">◆ </a></span>h5gclose_async_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gclose_async_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>grp_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>file</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in), optional</td> <td class="paramname"><span class="paramname"><em>line</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Asynchronously closes the specified group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">grp_id</td><td>Group identifier. </td></tr>
|
|
<tr><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">file</td><td>Pointer to filename the async subroutine is being called from, filename must be null character terminated </td></tr>
|
|
<tr><td class="paramname">func</td><td>Pointer to function name the async subroutine is being called in, func must be null character terminated </td></tr>
|
|
<tr><td class="paramname">line</td><td>Line number the async subroutine is being called at</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___a_s_y_n_c.html#gaedca4d2a02bac2dad772dc41dbdd6d68" title="H5Gclose_async()">H5Gclose_async()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga73669a0bfa54f59d82faffaf0ca70e24" name="ga73669a0bfa54f59d82faffaf0ca70e24"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga73669a0bfa54f59d82faffaf0ca70e24">◆ </a></span>h5gclose_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gclose_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>grp_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Closes the specified group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">grp_id</td><td>Group identifier. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="H5Gclose()">H5Gclose()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad6f5a657141854976db7d3626e46d65f" name="gad6f5a657141854976db7d3626e46d65f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad6f5a657141854976db7d3626e46d65f">◆ </a></span>h5gcreate_anon_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gcreate_anon_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(out)</td> <td class="paramname"><span class="paramname"><em>grp_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>gcpl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>gapl_id</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new empty group without linking it into the file structure. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">grp_id</td><td>Group identifier. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">gcpl_id</td><td>Group creation property list identifier. </td></tr>
|
|
<tr><td class="paramname">gapl_id</td><td>Group access property list identifier.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="H5Gcreate_anon()">H5Gcreate_anon()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8b7f6461c9790610bead7641385e3846" name="ga8b7f6461c9790610bead7641385e3846"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8b7f6461c9790610bead7641385e3846">◆ </a></span>h5gcreate_async_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gcreate_async_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(out)</td> <td class="paramname"><span class="paramname"><em>grp_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(size_t), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>size_hint</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>lcpl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>gcpl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>gapl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>file</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in), optional</td> <td class="paramname"><span class="paramname"><em>line</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Asynchronously creates a new group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Group name at the specified location. </td></tr>
|
|
<tr><td class="paramname">grp_id</td><td>Group identifier. </td></tr>
|
|
<tr><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">size_hint</td><td>A parameter indicating the number of bytes to reserve for the names that will appear in the group. Set to OBJECT_NAMELEN_DEFAULT_F if using any of the optional parameters lcpl_id, gcpl_id, and/or gapl_id when not using keywords in specifying the optional parameters. See <a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="H5Gcreate1()">H5Gcreate1()</a>. </td></tr>
|
|
<tr><td class="paramname">lcpl_id</td><td>Property list for link creation. </td></tr>
|
|
<tr><td class="paramname">gcpl_id</td><td>Property list for group creation. </td></tr>
|
|
<tr><td class="paramname">gapl_id</td><td>Property list for group access. </td></tr>
|
|
<tr><td class="paramname">file</td><td>Pointer to filename the async subroutine is being called from, filename must be null character terminated </td></tr>
|
|
<tr><td class="paramname">func</td><td>Pointer to function name the async subroutine is being called in, func must be null character terminated </td></tr>
|
|
<tr><td class="paramname">line</td><td>Line number the async subroutine is being called at</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___a_s_y_n_c.html#gaae55331055ebaab0da4dad974b1b0c91" title="H5Gcreate_async()">H5Gcreate_async()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga46671f95224d65f76bd160172d780b5f" name="ga46671f95224d65f76bd160172d780b5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga46671f95224d65f76bd160172d780b5f">◆ </a></span>h5gcreate_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gcreate_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(out)</td> <td class="paramname"><span class="paramname"><em>grp_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(size_t), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>size_hint</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>lcpl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>gcpl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>gapl_id</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Group name at the specified location. </td></tr>
|
|
<tr><td class="paramname">grp_id</td><td>Group identifier. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">size_hint</td><td>A parameter indicating the number of bytes to reserve for the names that will appear in the group. Set to OBJECT_NAMELEN_DEFAULT_F if using any of the optional parameters lcpl_id, gcpl_id, and/or gapl_id when not using keywords in specifying the optional parameters. See <a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="H5Gcreate1()">H5Gcreate1()</a>. </td></tr>
|
|
<tr><td class="paramname">lcpl_id</td><td>Property list for link creation. </td></tr>
|
|
<tr><td class="paramname">gcpl_id</td><td>Property list for group creation. </td></tr>
|
|
<tr><td class="paramname">gapl_id</td><td>Property list for group access.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9" title="H5Gcreate2()">H5Gcreate2()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8df2de290bddd8a4baf019fb5f687354" name="ga8df2de290bddd8a4baf019fb5f687354"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8df2de290bddd8a4baf019fb5f687354">◆ </a></span>h5gget_comment_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_comment_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(size_t), intent(in)</td> <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=size), intent(out)</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves comment for specified object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the object at specified location. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the buffer required to hold comment. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>Buffer to hold object's comment. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gac5a1c3e1ed4264d92cc02ca20afc57f4" title="H5Gget_comment()">H5Gget_comment()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gacba3215c2be6f7613f18bd5a3238628c" name="gacba3215c2be6f7613f18bd5a3238628c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacba3215c2be6f7613f18bd5a3238628c">◆ </a></span>h5gget_create_plist_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_create_plist_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>grp_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(out)</td> <td class="paramname"><span class="paramname"><em>gcpl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets a group creation property list identifier. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">grp_id</td><td>Group identifier. </td></tr>
|
|
<tr><td class="paramname">gcpl_id</td><td>Group creation property list identifier. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#ga0b959a53cbffa48f5d68ce33b43b7ed8" title="H5Gget_create_plist()">H5Gget_create_plist()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga64432a92565ce151feb6a09881612952" name="ga64432a92565ce151feb6a09881612952"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga64432a92565ce151feb6a09881612952">◆ </a></span>h5gget_info_async_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_info_async_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(<a class="el" href="structh5g_1_1h5g__info__t.html">h5g_info_t</a>), intent(out), target</td> <td class="paramname"><span class="paramname"><em>ginfo</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>file</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in), optional</td> <td class="paramname"><span class="paramname"><em>line</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Asynchronously retrieves information about a group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
|
|
<tr><td class="paramname">ginfo</td><td>Derived type in which group information is returned. </td></tr>
|
|
<tr><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">file</td><td>Pointer to filename the async subroutine is being called from, filename must be null character terminated </td></tr>
|
|
<tr><td class="paramname">func</td><td>Pointer to function name the async subroutine is being called in, func must be null character terminated </td></tr>
|
|
<tr><td class="paramname">line</td><td>Line number the async subroutine is being called at</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___a_s_y_n_c.html#ga50a254bdae888fcd08fe42465b5f386f" title="H5Gget_info_async()">H5Gget_info_async()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8cf41f98e451da9eb02e364de4fc956a" name="ga8cf41f98e451da9eb02e364de4fc956a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8cf41f98e451da9eb02e364de4fc956a">◆ </a></span>h5gget_info_by_idx_async_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_info_by_idx_async_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>group_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>idx_type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>order</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>n</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(<a class="el" href="structh5g_1_1h5g__info__t.html">h5g_info_t</a>), intent(out), target</td> <td class="paramname"><span class="paramname"><em>ginfo</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>file</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in), optional</td> <td class="paramname"><span class="paramname"><em>line</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Asynchronously retrieves information about a group, according to the group's position within an index. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
|
|
<tr><td class="paramname">group_name</td><td>Name of group containing group for which information is to be retrieved. </td></tr>
|
|
<tr><td class="paramname">idx_type</td><td>Index type. </td></tr>
|
|
<tr><td class="paramname">order</td><td>Order of the count in the index. </td></tr>
|
|
<tr><td class="paramname">n</td><td>Position in the index of the group for which information is retrieved. </td></tr>
|
|
<tr><td class="paramname">ginfo</td><td>Derived type in which group information is returned. </td></tr>
|
|
<tr><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">lapl_id</td><td>Link access property list. </td></tr>
|
|
<tr><td class="paramname">file</td><td>Pointer to filename the async subroutine is being called from, filename must be null character terminated </td></tr>
|
|
<tr><td class="paramname">func</td><td>Pointer to function name the async subroutine is being called in, func must be null character terminated </td></tr>
|
|
<tr><td class="paramname">line</td><td>Line number the async subroutine is being called at</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___a_s_y_n_c.html#ga87d9d82991d998f5f1dd4378e611f46b" title="H5Gget_info_by_idx_async()">H5Gget_info_by_idx_async()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga11c96cfd376734b5c32b021b2321cf65" name="ga11c96cfd376734b5c32b021b2321cf65"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga11c96cfd376734b5c32b021b2321cf65">◆ </a></span>h5gget_info_by_idx_f() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_info_by_idx_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>group_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>idx_type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>order</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>n</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(<a class="el" href="structh5g_1_1h5g__info__t.html">h5g_info_t</a>), intent(out), target</td> <td class="paramname"><span class="paramname"><em>ginfo</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves information about a group, according to the group's position within an index. </p>
|
|
<dl class="section attention"><dt>Attention</dt><dd>The preferred API, Fortran 2003 version.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
|
|
<tr><td class="paramname">group_name</td><td>Name of group containing group for which information is to be retrieved. </td></tr>
|
|
<tr><td class="paramname">idx_type</td><td>Index type. </td></tr>
|
|
<tr><td class="paramname">order</td><td>Order of the count in the index. </td></tr>
|
|
<tr><td class="paramname">n</td><td>Position in the index of the group for which information is retrieved. </td></tr>
|
|
<tr><td class="paramname">ginfo</td><td>Derived type in which group information is returned. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">lapl_id</td><td>Link access property list.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#ga985f27ad1a164d99fa1f58c6de60ab00" title="H5Gget_info_by_idx()">H5Gget_info_by_idx()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga12ee3ea31500e465f74e762f5f01119b" name="ga12ee3ea31500e465f74e762f5f01119b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga12ee3ea31500e465f74e762f5f01119b">◆ </a></span>h5gget_info_by_idx_f() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_info_by_idx_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>group_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>idx_type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>order</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>n</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>storage_type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>nlinks</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>max_corder</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">logical, intent(out), optional</td> <td class="paramname"><span class="paramname"><em>mounted</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves information about a group, according to the group's position within an index. </p>
|
|
<dl class="section attention"><dt>Attention</dt><dd>Obsolete API, use the Fortran 2003 version instead.. Both nlinks and max_corder can overflow.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>File or group identifier. </td></tr>
|
|
<tr><td class="paramname">group_name</td><td>Name of group containing group for which information is to be retrieved. </td></tr>
|
|
<tr><td class="paramname">idx_type</td><td>Index type. </td></tr>
|
|
<tr><td class="paramname">order</td><td>Order of the count in the index. </td></tr>
|
|
<tr><td class="paramname">n</td><td>Position in the index of the group for which information is retrieved. </td></tr>
|
|
<tr><td class="paramname">storage_type</td><td>Type of storage for links in group: <ul>
|
|
<li>H5G_STORAGE_TYPE_COMPACT_F: Compact storage </li>
|
|
<li>H5G_STORAGE_TYPE_DENSE_F: Indexed storage </li>
|
|
<li>H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables, the original HDF5 structure </li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">nlinks</td><td>Number of links in group. </td></tr>
|
|
<tr><td class="paramname">max_corder</td><td>Current maximum creation order value for group. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">lapl_id</td><td>Link access property list. </td></tr>
|
|
<tr><td class="paramname">mounted</td><td>Whether group has a file mounted on it.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#ga985f27ad1a164d99fa1f58c6de60ab00" title="H5Gget_info_by_idx()">H5Gget_info_by_idx()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae7634ace200b31764d67867f9b02d0fd" name="gae7634ace200b31764d67867f9b02d0fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae7634ace200b31764d67867f9b02d0fd">◆ </a></span>h5gget_info_by_name_async_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_info_by_name_async_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(<a class="el" href="structh5g_1_1h5g__info__t.html">h5g_info_t</a>), intent(out), target</td> <td class="paramname"><span class="paramname"><em>ginfo</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>file</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in), optional</td> <td class="paramname"><span class="paramname"><em>line</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Asynchronously retrieves information about a group by its name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>File or group identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of group containing group for which information is to be retrieved. </td></tr>
|
|
<tr><td class="paramname">ginfo</td><td>Derived type in which group information is returned. </td></tr>
|
|
<tr><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">lapl_id</td><td>Link access property list. </td></tr>
|
|
<tr><td class="paramname">file</td><td>Pointer to filename the async subroutine is being called from, filename must be null character terminated </td></tr>
|
|
<tr><td class="paramname">func</td><td>Pointer to function name the async subroutine is being called in, func must be null character terminated </td></tr>
|
|
<tr><td class="paramname">line</td><td>Line number the async subroutine is being called at</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___a_s_y_n_c.html#ga79226604034b9f7d60aabbe48f53c18a" title="H5Gget_info_by_name_async()">H5Gget_info_by_name_async()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga2f07d9a9eea89d2a9b4be58bb4bb5bea" name="ga2f07d9a9eea89d2a9b4be58bb4bb5bea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2f07d9a9eea89d2a9b4be58bb4bb5bea">◆ </a></span>h5gget_info_by_name_f() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_info_by_name_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(<a class="el" href="structh5g_1_1h5g__info__t.html">h5g_info_t</a>), intent(out), target</td> <td class="paramname"><span class="paramname"><em>ginfo</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves information about a group by its name. </p>
|
|
<dl class="section attention"><dt>Attention</dt><dd>The preferred API, Fortran 2003 version.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>File or group identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of group containing group for which information is to be retrieved. </td></tr>
|
|
<tr><td class="paramname">ginfo</td><td>Derived type in which group information is returned. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">lapl_id</td><td>Link access property list.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gadedd0c73c98f2ada69305f2992c3300e" title="H5Gget_info_by_name()">H5Gget_info_by_name()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga91d7a8a2f0d027a68670091f2922d5db" name="ga91d7a8a2f0d027a68670091f2922d5db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga91d7a8a2f0d027a68670091f2922d5db">◆ </a></span>h5gget_info_by_name_f() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_info_by_name_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>storage_type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>nlinks</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>max_corder</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">logical, intent(out), optional</td> <td class="paramname"><span class="paramname"><em>mounted</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves information about a group by its name. </p>
|
|
<dl class="section attention"><dt>Attention</dt><dd>Obsolete API, use the Fortran 2003 version instead.. Both nlinks and max_corder can overflow.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>File or group identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of group containing group for which information is to be retrieved. </td></tr>
|
|
<tr><td class="paramname">storage_type</td><td>Type of storage for links in group: <ul>
|
|
<li>H5G_STORAGE_TYPE_COMPACT_F: Compact storage </li>
|
|
<li>H5G_STORAGE_TYPE_DENSE_F: Indexed storage </li>
|
|
<li>H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables, the original HDF5 structure </li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">nlinks</td><td>Number of links in group. </td></tr>
|
|
<tr><td class="paramname">max_corder</td><td>Current maximum creation order value for group. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">lapl_id</td><td>Link access property list. </td></tr>
|
|
<tr><td class="paramname">mounted</td><td>Whether group has a file mounted on it.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gadedd0c73c98f2ada69305f2992c3300e" title="H5Gget_info_by_name()">H5Gget_info_by_name()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga342819ce799f2124195507d73f359e81" name="ga342819ce799f2124195507d73f359e81"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga342819ce799f2124195507d73f359e81">◆ </a></span>h5gget_info_f() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_info_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(<a class="el" href="structh5g_1_1h5g__info__t.html">h5g_info_t</a>), intent(out), target</td> <td class="paramname"><span class="paramname"><em>ginfo</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves information about a group. </p>
|
|
<dl class="section attention"><dt>Attention</dt><dd>The preferred API, Fortran 2003 version.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
|
|
<tr><td class="paramname">ginfo</td><td>Derived type in which group information is returned. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gad4be126ab7bbf2001435e8e70089f3d3" title="H5Gget_info()">H5Gget_info()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab33eace70c2d660bf41508cd82fd14a5" name="gab33eace70c2d660bf41508cd82fd14a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab33eace70c2d660bf41508cd82fd14a5">◆ </a></span>h5gget_info_f() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_info_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>storage_type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>nlinks</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>max_corder</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">logical, intent(out), optional</td> <td class="paramname"><span class="paramname"><em>mounted</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves information about a group. </p>
|
|
<dl class="section attention"><dt>Attention</dt><dd>Obsolete API, use the Fortran 2003 version instead.. Both nlinks and max_corder can overflow.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
|
|
<tr><td class="paramname">storage_type</td><td>Type of storage for links in group: <ul>
|
|
<li>H5G_STORAGE_TYPE_COMPACT_F: Compact storage </li>
|
|
<li>H5G_STORAGE_TYPE_DENSE_F: Indexed storage </li>
|
|
<li>H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables, the original HDF5 structure </li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">nlinks</td><td>Number of links in group. </td></tr>
|
|
<tr><td class="paramname">max_corder</td><td>Current maximum creation order value for group. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">mounted</td><td>Whether group has a file mounted on it.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gad4be126ab7bbf2001435e8e70089f3d3" title="H5Gget_info()">H5Gget_info()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga27e2caf17b1150077d73fe0eeec001ae" name="ga27e2caf17b1150077d73fe0eeec001ae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga27e2caf17b1150077d73fe0eeec001ae">◆ </a></span>h5gget_linkval_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_linkval_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(size_t), intent(in)</td> <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=size), intent(out)</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the name of the object that the symbolic link points to. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Symbolic link to the object whose name is to be returned. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Maximum number of characters to be returned. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>A buffer to hold the name of the object being sought. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#ga3a994ec16caa60edd7bb6c71c6fdc5aa" title="H5Gget_linkval()">H5Gget_linkval()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6116470c2445a092063531fe66caf7a6" name="ga6116470c2445a092063531fe66caf7a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6116470c2445a092063531fe66caf7a6">◆ </a></span>h5gget_obj_info_idx_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gget_obj_info_idx_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>idx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(out)</td> <td class="paramname"><span class="paramname"><em>obj_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>obj_type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns name and type of the group member identified by its index. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the group at the specified location. </td></tr>
|
|
<tr><td class="paramname">idx</td><td>Object index (zero-based). </td></tr>
|
|
<tr><td class="paramname">obj_name</td><td>Object name. </td></tr>
|
|
<tr><td class="paramname">obj_type</td><td>Object type. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac81976336d2bdaebd4cb61c1a6b57955" name="gac81976336d2bdaebd4cb61c1a6b57955"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac81976336d2bdaebd4cb61c1a6b57955">◆ </a></span>h5glink2_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5glink2_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>cur_loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>cur_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>link_type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>new_loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>new_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a link of the specified type from new_name to current_name. current_name and new_name are interpreted relative to current and new location identifiers. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cur_loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">cur_name</td><td>Name of the existing object if link is a hard link. Can be anything for the soft link. </td></tr>
|
|
<tr><td class="paramname">link_type</td><td>Link type; possible values are: <ul>
|
|
<li>H5G_LINK_HARD_F </li>
|
|
<li>H5G_LINK_SOFT_F </li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">new_loc_id</td><td>New location identifier. </td></tr>
|
|
<tr><td class="paramname">new_name</td><td>New name for the object. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gafabd07a7f64a7cbef27c56a3bee2df47" title="H5Glink2()">H5Glink2()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaae1f4d458c2ff152d9af0712fc5a02ec" name="gaae1f4d458c2ff152d9af0712fc5a02ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaae1f4d458c2ff152d9af0712fc5a02ec">◆ </a></span>h5glink_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5glink_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>link_type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>current_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>new_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a link of the specified type from new_name to current_name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">link_type</td><td>Link type; possible values are: <ul>
|
|
<li>H5G_LINK_HARD_F </li>
|
|
<li>H5G_LINK_SOFT_F </li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">current_name</td><td>Name of the existing object if link is a hard link. Can be anything for the soft link. </td></tr>
|
|
<tr><td class="paramname">new_name</td><td>New name for the object. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#ga1b9b2effdc1727613f81c4dcb2a4d644" title="H5Glink()">H5Glink()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3691ae6c786a83cf37605a4a9573775b" name="ga3691ae6c786a83cf37605a4a9573775b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3691ae6c786a83cf37605a4a9573775b">◆ </a></span>h5gmove2_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gmove2_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>src_loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>src_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>dst_loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>dst_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Renames an object within an HDF5 file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">src_loc_id</td><td>Original location identifier. </td></tr>
|
|
<tr><td class="paramname">src_name</td><td>Object's name at specified original location. </td></tr>
|
|
<tr><td class="paramname">dst_loc_id</td><td>Original location identifier. </td></tr>
|
|
<tr><td class="paramname">dst_name</td><td>Object's new name. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gad97bf21798b06b63df0bdd404cac562c" title="H5Gmove2()">H5Gmove2()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga01f3177b62f15e3e79f6eaf34fb62e05" name="ga01f3177b62f15e3e79f6eaf34fb62e05"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga01f3177b62f15e3e79f6eaf34fb62e05">◆ </a></span>h5gmove_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gmove_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>new_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Renames an object within an HDF5 file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Object's name at specified location. </td></tr>
|
|
<tr><td class="paramname">new_name</td><td>Object's new name. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gaa6474351d346ad45309ae0b22ebdde9a" title="H5Gmove()">H5Gmove()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga40d5ac9dabbc09716a43f79578bad04d" name="ga40d5ac9dabbc09716a43f79578bad04d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga40d5ac9dabbc09716a43f79578bad04d">◆ </a></span>h5gn_members_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gn_members_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>nmembers</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the number of group members. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the group at the specified location. </td></tr>
|
|
<tr><td class="paramname">nmembers</td><td>Number of group members. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad9fe7e599935454227309bdaeb163b21" name="gad9fe7e599935454227309bdaeb163b21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad9fe7e599935454227309bdaeb163b21">◆ </a></span>h5gopen_async_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gopen_async_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(out)</td> <td class="paramname"><span class="paramname"><em>grp_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>gapl_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>file</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">type(c_ptr), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(in), optional</td> <td class="paramname"><span class="paramname"><em>line</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Asynchronously opens an existing group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the group to open. </td></tr>
|
|
<tr><td class="paramname">grp_id</td><td>Group identifier. </td></tr>
|
|
<tr><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">gapl_id</td><td>Group access property list identifier. </td></tr>
|
|
<tr><td class="paramname">file</td><td>Pointer to filename the async subroutine is being called from, filename must be null character terminated </td></tr>
|
|
<tr><td class="paramname">func</td><td>Pointer to function name the async subroutine is being called in, func must be null character terminated </td></tr>
|
|
<tr><td class="paramname">line</td><td>Line number the async subroutine is being called at</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___a_s_y_n_c.html#ga51711cab3f8ae549df283aa2ba384527" title="H5Gopen_async()">H5Gopen_async()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1ef9a46fd72dd543eeabf9fc33a5fe63" name="ga1ef9a46fd72dd543eeabf9fc33a5fe63"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1ef9a46fd72dd543eeabf9fc33a5fe63">◆ </a></span>h5gopen_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gopen_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(out)</td> <td class="paramname"><span class="paramname"><em>grp_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>gapl_id</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens an existing group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the group to open. </td></tr>
|
|
<tr><td class="paramname">grp_id</td><td>Group identifier. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr>
|
|
<tr><td class="paramname">gapl_id</td><td>Group access property list identifier.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403" title="H5Gopen2()">H5Gopen2()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf5e8a26b2b946bf75e08d1e7fd9a58dd" name="gaf5e8a26b2b946bf75e08d1e7fd9a58dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf5e8a26b2b946bf75e08d1e7fd9a58dd">◆ </a></span>h5gset_comment_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gset_comment_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>comment</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets comment for specified object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the object. </td></tr>
|
|
<tr><td class="paramname">comment</td><td>Comment to set for the object. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#ga7a615715ea68fc1bf11484a8278fe682" title="H5Gset_comment()">H5Gset_comment()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0f91bf4cf51439c7d9f2994e809b7322" name="ga0f91bf4cf51439c7d9f2994e809b7322"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0f91bf4cf51439c7d9f2994e809b7322">◆ </a></span>h5gunlink_f()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine h5gunlink_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>hdferr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Removes the specified name from the group graph and decrements the link count for the object to which name points. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">loc_id</td><td>Location identifier. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the object to unlink. </td></tr>
|
|
<tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See C API: <a class="el" href="group___h5_g.html#gacb843cbd5bbb816cfa9c855463d1e51c" title="H5Gunlink()">H5Gunlink()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="doc-var-members" id="doc-var-members"></a><h2 id="header-doc-var-members" class="groupheader">Variable Documentation</h2>
|
|
<a id="ga2508046cee8c9071688f4beab505ec49" name="ga2508046cee8c9071688f4beab505ec49"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2508046cee8c9071688f4beab505ec49">◆ </a></span>h5g_dataset_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_dataset_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_DATASET. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga37730c4224493dc435a96aeed68071f3" name="ga37730c4224493dc435a96aeed68071f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga37730c4224493dc435a96aeed68071f3">◆ </a></span>h5g_group_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_group_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_GROUP. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga30653bcf0fcfb996b3df97bbb7bc5a20" name="ga30653bcf0fcfb996b3df97bbb7bc5a20"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga30653bcf0fcfb996b3df97bbb7bc5a20">◆ </a></span>h5g_link_error_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_link_error_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_LINK_ERROR. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga88b294a23d435761acc3eceaedc2dfe0" name="ga88b294a23d435761acc3eceaedc2dfe0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga88b294a23d435761acc3eceaedc2dfe0">◆ </a></span>h5g_link_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_link_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_LINK. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gabfbff6eef1d9d1e4553fac89bed7382e" name="gabfbff6eef1d9d1e4553fac89bed7382e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabfbff6eef1d9d1e4553fac89bed7382e">◆ </a></span>h5g_link_hard_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_link_hard_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_LINK_HARD. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga94af2f0ea4eac5e167b3cdcb88dc0544" name="ga94af2f0ea4eac5e167b3cdcb88dc0544"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga94af2f0ea4eac5e167b3cdcb88dc0544">◆ </a></span>h5g_link_soft_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_link_soft_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_LINK_SOFT. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6d1fad1141975d70db7610fabde9e26a" name="ga6d1fad1141975d70db7610fabde9e26a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6d1fad1141975d70db7610fabde9e26a">◆ </a></span>h5g_same_loc_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_same_loc_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_SAME_LOC. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8bb2e9737aa90960668e27f7310f101a" name="ga8bb2e9737aa90960668e27f7310f101a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8bb2e9737aa90960668e27f7310f101a">◆ </a></span>h5g_storage_type_compact_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_storage_type_compact_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_STORAGE_TYPE_COMPACT. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga876361ba67a36f2901eb49972c457917" name="ga876361ba67a36f2901eb49972c457917"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga876361ba67a36f2901eb49972c457917">◆ </a></span>h5g_storage_type_dense_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_storage_type_dense_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_STORAGE_TYPE_DENSE. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf5e1c293b9d50c3f5d4f7f98682f5c0a" name="gaf5e1c293b9d50c3f5d4f7f98682f5c0a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf5e1c293b9d50c3f5d4f7f98682f5c0a">◆ </a></span>h5g_storage_type_symbol_table_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_storage_type_symbol_table_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_STORAGE_TYPE_SYMBOL_TABLE. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5efe327155edcd2eea9b7084cd807601" name="ga5efe327155edcd2eea9b7084cd807601"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5efe327155edcd2eea9b7084cd807601">◆ </a></span>h5g_storage_type_unknown_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_storage_type_unknown_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_STORAGE_TYPE_UNKNOWN. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3d128641813ad9ec6ef6c6a5db17df0b" name="ga3d128641813ad9ec6ef6c6a5db17df0b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3d128641813ad9ec6ef6c6a5db17df0b">◆ </a></span>h5g_type_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_type_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_TYPE. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5b48366c7e731f5d81399f0304e0efaa" name="ga5b48366c7e731f5d81399f0304e0efaa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5b48366c7e731f5d81399f0304e0efaa">◆ </a></span>h5g_udlink_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_udlink_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_UDLINK. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8aa3fccdcdca39b9ea82068e10c283a8" name="ga8aa3fccdcdca39b9ea82068e10c283a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8aa3fccdcdca39b9ea82068e10c283a8">◆ </a></span>h5g_unknown_f</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">integer h5g_unknown_f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>H5G_UNKNOWN. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|