diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:51:37 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:51:37 (GMT) |
| commit | 4b5805be2b387289d3f148308b1812fad3e6e157 (patch) | |
| tree | 18ed4d6a5a427791bbf70b078aa906027bdfedb9 /v1_14/group___f_h5_l.html | |
| parent | 4f20d880c97be1249f8d89ced95f72836dbf3ee0 (diff) | |
| download | hdf5-4b5805be2b387289d3f148308b1812fad3e6e157.zip hdf5-4b5805be2b387289d3f148308b1812fad3e6e157.tar.gz hdf5-4b5805be2b387289d3f148308b1812fad3e6e157.tar.bz2 | |
deploy: af8c1d1d872112ad741bbf05dda792c1626b93fd
Diffstat (limited to 'v1_14/group___f_h5_l.html')
| -rw-r--r-- | v1_14/group___f_h5_l.html | 2211 |
1 files changed, 2211 insertions, 0 deletions
diff --git a/v1_14/group___f_h5_l.html b/v1_14/group___f_h5_l.html new file mode 100644 index 0000000..ba472ca --- /dev/null +++ b/v1_14/group___f_h5_l.html @@ -0,0 +1,2211 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>HDF5: Fortran Link (H5L) 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="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(function() { init_search(); }); +/* @license-end */ +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="hdf5doxy.css" rel="stylesheet" type="text/css"> +<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/> + --> +<script type="text/javascript" src="hdf5_navtree_hacks.js"></script> +</head> +<body> +<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a> +  <span id="projectnumber">1.14.4.af8c1d1</span> + </div> + <div id="projectbrief">API Reference</div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.svg" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> + </span> + </div> +</td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('group___f_h5_l.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions/Subroutines</a> | +<a href="#var-members">Variables</a> </div> + <div class="headertitle"> +<div class="title">Fortran Link (H5L) Interface</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_l.html">Links (H5L)</a>, C-API</dd> +<dd> +<a class="el" href="_h5_l__u_g.html">The HDF5 Links</a>, User Guide </dd></dl> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions/Subroutines</h2></td></tr> +<tr class="memitem:ga77c3d23c13ea6888b93d583c827b4643"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga77c3d23c13ea6888b93d583c827b4643">h5lcopy_f</a> (src_loc_id, src_name, dest_loc_id, dest_name, hdferr, lcpl_id, lapl_id)</td></tr> +<tr class="memdesc:ga77c3d23c13ea6888b93d583c827b4643"><td class="mdescLeft"> </td><td class="mdescRight">Copies a link from one location to another. <a href="group___f_h5_l.html#ga77c3d23c13ea6888b93d583c827b4643">More...</a><br /></td></tr> +<tr class="separator:ga77c3d23c13ea6888b93d583c827b4643"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaed9e00c1376f8c080e1b87a9a2db0abb"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#gaed9e00c1376f8c080e1b87a9a2db0abb">h5ldelete_f</a> (loc_id, name, hdferr, lapl_id)</td></tr> +<tr class="memdesc:gaed9e00c1376f8c080e1b87a9a2db0abb"><td class="mdescLeft"> </td><td class="mdescRight">Removes a link from a group. <a href="group___f_h5_l.html#gaed9e00c1376f8c080e1b87a9a2db0abb">More...</a><br /></td></tr> +<tr class="separator:gaed9e00c1376f8c080e1b87a9a2db0abb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga79d92d8ac7efc7d6d05f49cda1f21810"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga79d92d8ac7efc7d6d05f49cda1f21810">h5ldelete_async_f</a> (loc_id, name, es_id, hdferr, lapl_id, file, func, line)</td></tr> +<tr class="memdesc:ga79d92d8ac7efc7d6d05f49cda1f21810"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously removes a link from a group. <a href="group___f_h5_l.html#ga79d92d8ac7efc7d6d05f49cda1f21810">More...</a><br /></td></tr> +<tr class="separator:ga79d92d8ac7efc7d6d05f49cda1f21810"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga52446a8b94ae33a65332b3f02b151816"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga52446a8b94ae33a65332b3f02b151816">h5lcreate_soft_f</a> (target_path, link_loc_id, link_name, hdferr, lcpl_id, lapl_id)</td></tr> +<tr class="memdesc:ga52446a8b94ae33a65332b3f02b151816"><td class="mdescLeft"> </td><td class="mdescRight">Creates a soft link to an object. <a href="group___f_h5_l.html#ga52446a8b94ae33a65332b3f02b151816">More...</a><br /></td></tr> +<tr class="separator:ga52446a8b94ae33a65332b3f02b151816"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6b742d1c327ae6a6495e3cd69ee98487"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga6b742d1c327ae6a6495e3cd69ee98487">h5lcreate_soft_async_f</a> (target_path, link_loc_id, link_name, es_id, hdferr, lcpl_id, lapl_id, file, func, line)</td></tr> +<tr class="memdesc:ga6b742d1c327ae6a6495e3cd69ee98487"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously creates a soft link to an object. <a href="group___f_h5_l.html#ga6b742d1c327ae6a6495e3cd69ee98487">More...</a><br /></td></tr> +<tr class="separator:ga6b742d1c327ae6a6495e3cd69ee98487"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga09bde858e3d6544eaa56f129e5da0375"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga09bde858e3d6544eaa56f129e5da0375">h5lcreate_hard_f</a> (obj_loc_id, obj_name, link_loc_id, link_name, hdferr, lcpl_id, lapl_id)</td></tr> +<tr class="memdesc:ga09bde858e3d6544eaa56f129e5da0375"><td class="mdescLeft"> </td><td class="mdescRight">Creates a hard link to an object. <a href="group___f_h5_l.html#ga09bde858e3d6544eaa56f129e5da0375">More...</a><br /></td></tr> +<tr class="separator:ga09bde858e3d6544eaa56f129e5da0375"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga45dd519b8bcbc122012a277089b315c9"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga45dd519b8bcbc122012a277089b315c9">h5lcreate_hard_async_f</a> (obj_loc_id, obj_name, link_loc_id, link_name, es_id, hdferr, lcpl_id, lapl_id, file, func, line)</td></tr> +<tr class="memdesc:ga45dd519b8bcbc122012a277089b315c9"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously creates a hard link to an object. <a href="group___f_h5_l.html#ga45dd519b8bcbc122012a277089b315c9">More...</a><br /></td></tr> +<tr class="separator:ga45dd519b8bcbc122012a277089b315c9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga31d20cab71a6a36fb27ee41510428d24"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga31d20cab71a6a36fb27ee41510428d24">h5lcreate_external_f</a> (file_name, obj_name, link_loc_id, link_name, hdferr, lcpl_id, lapl_id)</td></tr> +<tr class="memdesc:ga31d20cab71a6a36fb27ee41510428d24"><td class="mdescLeft"> </td><td class="mdescRight">Creates a soft link to an object in a different file. <a href="group___f_h5_l.html#ga31d20cab71a6a36fb27ee41510428d24">More...</a><br /></td></tr> +<tr class="separator:ga31d20cab71a6a36fb27ee41510428d24"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab401110c42ef57285d311b54f8495f4c"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#gab401110c42ef57285d311b54f8495f4c">h5ldelete_by_idx_f</a> (loc_id, group_name, index_field, order, n, hdferr, lapl_id)</td></tr> +<tr class="memdesc:gab401110c42ef57285d311b54f8495f4c"><td class="mdescLeft"> </td><td class="mdescRight">Removes the nth link in a group. <a href="group___f_h5_l.html#gab401110c42ef57285d311b54f8495f4c">More...</a><br /></td></tr> +<tr class="separator:gab401110c42ef57285d311b54f8495f4c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5cad7854dd1986ca92a5595a0e1e5298"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga5cad7854dd1986ca92a5595a0e1e5298">h5ldelete_by_idx_async_f</a> (loc_id, group_name, index_field, order, n, es_id, hdferr, lapl_id, file, func, line)</td></tr> +<tr class="memdesc:ga5cad7854dd1986ca92a5595a0e1e5298"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously removes the nth link in a group. <a href="group___f_h5_l.html#ga5cad7854dd1986ca92a5595a0e1e5298">More...</a><br /></td></tr> +<tr class="separator:ga5cad7854dd1986ca92a5595a0e1e5298"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga33f8908c3915302600d6753a84bd9f82"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga33f8908c3915302600d6753a84bd9f82">h5lexists_f</a> (loc_id, name, link_exists, hdferr, lapl_id)</td></tr> +<tr class="memdesc:ga33f8908c3915302600d6753a84bd9f82"><td class="mdescLeft"> </td><td class="mdescRight">Check if a link with a particular name exists in a group. <a href="group___f_h5_l.html#ga33f8908c3915302600d6753a84bd9f82">More...</a><br /></td></tr> +<tr class="separator:ga33f8908c3915302600d6753a84bd9f82"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga70e8f9f58e20b3456b2ed530a8554d5b"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga70e8f9f58e20b3456b2ed530a8554d5b">h5lexists_async_f</a> (loc_id, name, link_exists, es_id, hdferr, lapl_id, file, func, line)</td></tr> +<tr class="memdesc:ga70e8f9f58e20b3456b2ed530a8554d5b"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously checks if a link with a particular name exists in a group. <a href="group___f_h5_l.html#ga70e8f9f58e20b3456b2ed530a8554d5b">More...</a><br /></td></tr> +<tr class="separator:ga70e8f9f58e20b3456b2ed530a8554d5b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3ff434a804014217c9ba96d98c95aa75"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga3ff434a804014217c9ba96d98c95aa75">h5lget_info_f</a> (link_loc_id, link_name, cset, corder, f_corder_valid, link_type, token, val_size, hdferr, lapl_id)</td></tr> +<tr class="memdesc:ga3ff434a804014217c9ba96d98c95aa75"><td class="mdescLeft"> </td><td class="mdescRight">Returns information about a link. <a href="group___f_h5_l.html#ga3ff434a804014217c9ba96d98c95aa75">More...</a><br /></td></tr> +<tr class="separator:ga3ff434a804014217c9ba96d98c95aa75"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2d9b80bf47d989f277ad3b01bcb4af0f"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga2d9b80bf47d989f277ad3b01bcb4af0f">h5lget_info_by_idx_f</a> (loc_id, group_name, index_field, order, n, link_type, f_corder_valid, corder, cset, token, val_size, hdferr, lapl_id)</td></tr> +<tr class="memdesc:ga2d9b80bf47d989f277ad3b01bcb4af0f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves metadata for a link in a group, according to the order within a field or index. <a href="group___f_h5_l.html#ga2d9b80bf47d989f277ad3b01bcb4af0f">More...</a><br /></td></tr> +<tr class="separator:ga2d9b80bf47d989f277ad3b01bcb4af0f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga83751f44c400576d675a3f293e515209"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga83751f44c400576d675a3f293e515209">h5lis_registered_f</a> (link_cls_id, registered, hdferr)</td></tr> +<tr class="memdesc:ga83751f44c400576d675a3f293e515209"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a class of user-defined links is registered. <a href="group___f_h5_l.html#ga83751f44c400576d675a3f293e515209">More...</a><br /></td></tr> +<tr class="separator:ga83751f44c400576d675a3f293e515209"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9e0662219e9782d91250ca6627b574b6"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga9e0662219e9782d91250ca6627b574b6">h5lmove_f</a> (src_loc_id, src_name, dest_loc_id, dest_name, hdferr, lcpl_id, lapl_id)</td></tr> +<tr class="memdesc:ga9e0662219e9782d91250ca6627b574b6"><td class="mdescLeft"> </td><td class="mdescRight">Renames a link within an HDF5 file. <a href="group___f_h5_l.html#ga9e0662219e9782d91250ca6627b574b6">More...</a><br /></td></tr> +<tr class="separator:ga9e0662219e9782d91250ca6627b574b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga99aa9227eaada35260ad838b8ed62659"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga99aa9227eaada35260ad838b8ed62659">h5lget_name_by_idx_f</a> (loc_id, group_name, index_field, order, n, name, hdferr, size, lapl_id)</td></tr> +<tr class="memdesc:ga99aa9227eaada35260ad838b8ed62659"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves name of the nth link in a group, according to the order within a specified field or index. <a href="group___f_h5_l.html#ga99aa9227eaada35260ad838b8ed62659">More...</a><br /></td></tr> +<tr class="separator:ga99aa9227eaada35260ad838b8ed62659"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga26cbb1a84d4dd500df6949d2a4a92e0d"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga26cbb1a84d4dd500df6949d2a4a92e0d">h5literate_f</a> (group_id, idx_type, order, idx, op, op_data, return_value, hdferr)</td></tr> +<tr class="memdesc:ga26cbb1a84d4dd500df6949d2a4a92e0d"><td class="mdescLeft"> </td><td class="mdescRight">$ SUBROUTINE h5lget_val_by_idx_f(loc_id, group_name, index_field, order, n, & $ f_corder_valid, corder, cset, data_size, hdferr, lapl_id) $ IMPLICIT NONE <a href="group___f_h5_l.html#ga26cbb1a84d4dd500df6949d2a4a92e0d">More...</a><br /></td></tr> +<tr class="separator:ga26cbb1a84d4dd500df6949d2a4a92e0d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad790e4fc4a233cf25d8be763cb620c53"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#gad790e4fc4a233cf25d8be763cb620c53">h5literate_async_f</a> (group_id, idx_type, order, idx, op, op_data, return_value, es_id, hdferr, file, func, line)</td></tr> +<tr class="memdesc:gad790e4fc4a233cf25d8be763cb620c53"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously iterates through links in a group. <a href="group___f_h5_l.html#gad790e4fc4a233cf25d8be763cb620c53">More...</a><br /></td></tr> +<tr class="separator:gad790e4fc4a233cf25d8be763cb620c53"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga79959b5c280fefeee6a9a4fd890e3918"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga79959b5c280fefeee6a9a4fd890e3918">h5literate_by_name_f</a> (loc_id, group_name, index_type, order, idx, op, op_data, return_value, hdferr, lapl_id)</td></tr> +<tr class="memdesc:ga79959b5c280fefeee6a9a4fd890e3918"><td class="mdescLeft"> </td><td class="mdescRight">Iterates through links in a group. <a href="group___f_h5_l.html#ga79959b5c280fefeee6a9a4fd890e3918">More...</a><br /></td></tr> +<tr class="separator:ga79959b5c280fefeee6a9a4fd890e3918"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2b70c18c17afcd7ca0509dc12f6e5ef3"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga2b70c18c17afcd7ca0509dc12f6e5ef3">h5lvisit_f</a> (grp_id, idx_type, order, op, op_data, return_value, hdferr)</td></tr> +<tr class="memdesc:ga2b70c18c17afcd7ca0509dc12f6e5ef3"><td class="mdescLeft"> </td><td class="mdescRight">Recursively visits all links starting from a specified group. <a href="group___f_h5_l.html#ga2b70c18c17afcd7ca0509dc12f6e5ef3">More...</a><br /></td></tr> +<tr class="separator:ga2b70c18c17afcd7ca0509dc12f6e5ef3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8c17b9a759f758374df64b2216dc514f"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga8c17b9a759f758374df64b2216dc514f">h5lvisit_by_name_f</a> (loc_id, group_name, idx_type, order, op, op_data, return_value, hdferr, lapl_id)</td></tr> +<tr class="memdesc:ga8c17b9a759f758374df64b2216dc514f"><td class="mdescLeft"> </td><td class="mdescRight">Recursively visits all links starting from a specified group. <a href="group___f_h5_l.html#ga8c17b9a759f758374df64b2216dc514f">More...</a><br /></td></tr> +<tr class="separator:ga8c17b9a759f758374df64b2216dc514f"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> +Variables</h2></td></tr> +<tr class="memitem:ga7eb0438f997d467c514e1758350004a3"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga7eb0438f997d467c514e1758350004a3">h5l_type_error_f</a></td></tr> +<tr class="memdesc:ga7eb0438f997d467c514e1758350004a3"><td class="mdescLeft"> </td><td class="mdescRight">H5L_TYPE_ERROR. <a href="group___f_h5_l.html#ga7eb0438f997d467c514e1758350004a3">More...</a><br /></td></tr> +<tr class="separator:ga7eb0438f997d467c514e1758350004a3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7f46e8015570c850d46fc2c04462573f"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga7f46e8015570c850d46fc2c04462573f">h5l_type_hard_f</a></td></tr> +<tr class="memdesc:ga7f46e8015570c850d46fc2c04462573f"><td class="mdescLeft"> </td><td class="mdescRight">H5L_TYPE_HARD. <a href="group___f_h5_l.html#ga7f46e8015570c850d46fc2c04462573f">More...</a><br /></td></tr> +<tr class="separator:ga7f46e8015570c850d46fc2c04462573f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9942d93ab69e3c609f4e2357a93b7ce0"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga9942d93ab69e3c609f4e2357a93b7ce0">h5l_type_soft_f</a></td></tr> +<tr class="memdesc:ga9942d93ab69e3c609f4e2357a93b7ce0"><td class="mdescLeft"> </td><td class="mdescRight">H5L_TYPE_SOFT. <a href="group___f_h5_l.html#ga9942d93ab69e3c609f4e2357a93b7ce0">More...</a><br /></td></tr> +<tr class="separator:ga9942d93ab69e3c609f4e2357a93b7ce0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2eb38e4b58b76e1fa18d8b884f1cfd26"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga2eb38e4b58b76e1fa18d8b884f1cfd26">h5l_type_external_f</a></td></tr> +<tr class="memdesc:ga2eb38e4b58b76e1fa18d8b884f1cfd26"><td class="mdescLeft"> </td><td class="mdescRight">H5L_TYPE_EXTERNAL. <a href="group___f_h5_l.html#ga2eb38e4b58b76e1fa18d8b884f1cfd26">More...</a><br /></td></tr> +<tr class="separator:ga2eb38e4b58b76e1fa18d8b884f1cfd26"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaae5ada36912c6d058d219aef3aa18477"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#gaae5ada36912c6d058d219aef3aa18477">h5l_same_loc_f</a></td></tr> +<tr class="memdesc:gaae5ada36912c6d058d219aef3aa18477"><td class="mdescLeft"> </td><td class="mdescRight">H5L_SAME_LOC. <a href="group___f_h5_l.html#gaae5ada36912c6d058d219aef3aa18477">More...</a><br /></td></tr> +<tr class="separator:gaae5ada36912c6d058d219aef3aa18477"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9286668bf707376ba5d7a999c35befee"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_l.html#ga9286668bf707376ba5d7a999c35befee">h5l_link_class_t_vers_f</a></td></tr> +<tr class="memdesc:ga9286668bf707376ba5d7a999c35befee"><td class="mdescLeft"> </td><td class="mdescRight">H5L_LINK_CLASS_T_VERS. <a href="group___f_h5_l.html#ga9286668bf707376ba5d7a999c35befee">More...</a><br /></td></tr> +<tr class="separator:ga9286668bf707376ba5d7a999c35befee"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function/Subroutine Documentation</h2> +<a id="ga77c3d23c13ea6888b93d583c827b4643"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga77c3d23c13ea6888b93d583c827b4643">◆ </a></span>h5lcopy_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lcopy_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"><em>src_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>src_name</em>, </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"><em>dest_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dest_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lcpl_id</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Copies a link from one location to another. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">src_loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr> + <tr><td class="paramname">src_name</td><td>Name of the link to be copied. </td></tr> + <tr><td class="paramname">dest_loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr> + <tr><td class="paramname">dest_name</td><td>Name to be assigned to the new copy. </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr> + <tr><td class="paramname">lcpl_id</td><td>Link creation property list identifier. </td></tr> + <tr><td class="paramname">lapl_id</td><td>Link access property list identifier.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_l.html#gafd4624f1c040d5f1df36cb1e6986aac6">H5Lcopy()</a> </p> + +</div> +</div> +<a id="ga31d20cab71a6a36fb27ee41510428d24"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga31d20cab71a6a36fb27ee41510428d24">◆ </a></span>h5lcreate_external_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lcreate_external_f </td> + <td>(</td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>file_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>obj_name</em>, </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"><em>link_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>link_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lcpl_id</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates a soft link to an object in a different file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_name</td><td>Name of the file containing the target object. Neither the file nor the target object is required to exist. May be the file the link is being created in. </td></tr> + <tr><td class="paramname">obj_name</td><td>Path within the target file to the target object. </td></tr> + <tr><td class="paramname">link_loc_id</td><td>The file or group identifier for the new link. </td></tr> + <tr><td class="paramname">link_name</td><td>The name of the new link. </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr> + <tr><td class="paramname">lcpl_id</td><td>Link creation property list identifier. </td></tr> + <tr><td class="paramname">lapl_id</td><td>Link access property list identifier.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_l.html#ga15dfaeb9b1c0b3136533cb97ee45e683">H5Lcreate_external()</a> </p> + +</div> +</div> +<a id="ga45dd519b8bcbc122012a277089b315c9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga45dd519b8bcbc122012a277089b315c9">◆ </a></span>h5lcreate_hard_async_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lcreate_hard_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"><em>obj_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>obj_name</em>, </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"><em>link_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>link_name</em>, </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"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lcpl_id</em>, </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"><em>lapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>file</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in), optional </td> + <td class="paramname"><em>line</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Asynchronously creates a hard link to an object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_loc_id</td><td>The file or group identifier for the target object. </td></tr> + <tr><td class="paramname">obj_name</td><td>Name of the target object, which must already exist. </td></tr> + <tr><td class="paramname">link_loc_id</td><td>The file or group identifier for the new link. </td></tr> + <tr><td class="paramname">link_name</td><td>The name of the new link. </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">lcpl_id</td><td>Link creation property list identifier. </td></tr> + <tr><td class="paramname">lapl_id</td><td>Link 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#gaecc69b84cafb71d27dbcc244c35930c7">H5Lcreate_hard_async()</a> </p> + +</div> +</div> +<a id="ga09bde858e3d6544eaa56f129e5da0375"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga09bde858e3d6544eaa56f129e5da0375">◆ </a></span>h5lcreate_hard_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lcreate_hard_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"><em>obj_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>obj_name</em>, </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"><em>link_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>link_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lcpl_id</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates a hard link to an object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_loc_id</td><td>The file or group identifier for the target object. </td></tr> + <tr><td class="paramname">obj_name</td><td>Name of the target object, which must already exist. </td></tr> + <tr><td class="paramname">link_loc_id</td><td>The file or group identifier for the new link. </td></tr> + <tr><td class="paramname">link_name</td><td>The name of the new link. </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr> + <tr><td class="paramname">lcpl_id</td><td>Link creation property list identifier. </td></tr> + <tr><td class="paramname">lapl_id</td><td>Link access property list identifier.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_l.html#ga69d50f7acdfd2f1dc7c4372397e63bd2">H5Lcreate_hard()</a> </p> + +</div> +</div> +<a id="ga6b742d1c327ae6a6495e3cd69ee98487"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga6b742d1c327ae6a6495e3cd69ee98487">◆ </a></span>h5lcreate_soft_async_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lcreate_soft_async_f </td> + <td>(</td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>target_path</em>, </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"><em>link_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>link_name</em>, </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"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lcpl_id</em>, </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"><em>lapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>file</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in), optional </td> + <td class="paramname"><em>line</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Asynchronously creates a soft link to an object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">target_path</td><td>Path to the target object, which is not required to exist. </td></tr> + <tr><td class="paramname">link_loc_id</td><td>The file or group identifier for the new link. </td></tr> + <tr><td class="paramname">link_name</td><td>The name of the new link. </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">lcpl_id</td><td>Link creation property list identifier. </td></tr> + <tr><td class="paramname">lapl_id</td><td>Link 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#ga7ba84c7db6ef67e270fa7bc3413d4def">H5Lcreate_soft_async()</a> </p> + +</div> +</div> +<a id="ga52446a8b94ae33a65332b3f02b151816"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga52446a8b94ae33a65332b3f02b151816">◆ </a></span>h5lcreate_soft_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lcreate_soft_f </td> + <td>(</td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>target_path</em>, </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"><em>link_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>link_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lcpl_id</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates a soft link to an object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">target_path</td><td>Path to the target object, which is not required to exist. </td></tr> + <tr><td class="paramname">link_loc_id</td><td>The file or group identifier for the new link. </td></tr> + <tr><td class="paramname">link_name</td><td>The name of the new link. </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr> + <tr><td class="paramname">lcpl_id</td><td>Link creation property list identifier. </td></tr> + <tr><td class="paramname">lapl_id</td><td>Link access property list identifier.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_l.html#ga894444623b58ce1ac3bd35538245ac78">H5Lcreate_soft()</a> </p> + +</div> +</div> +<a id="ga79d92d8ac7efc7d6d05f49cda1f21810"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga79d92d8ac7efc7d6d05f49cda1f21810">◆ </a></span>h5ldelete_async_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5ldelete_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>name</em>, </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"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>file</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in), optional </td> + <td class="paramname"><em>line</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Asynchronously removes a link from a group. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Identifier of the file or group containing the object. </td></tr> + <tr><td class="paramname">name</td><td>Name of the link to delete. </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 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#ga6074beb8fd1d7761db082fc611519b54">H5Ldelete_async()</a> </p> + +</div> +</div> +<a id="ga5cad7854dd1986ca92a5595a0e1e5298"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5cad7854dd1986ca92a5595a0e1e5298">◆ </a></span>h5ldelete_by_idx_async_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5ldelete_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>group_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>index_field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>order</em>, </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"><em>n</em>, </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"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>file</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in), optional </td> + <td class="paramname"><em>line</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Asynchronously removes the nth link in a group. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>File or group identifier specifying location of subject group. </td></tr> + <tr><td class="paramname">group_name</td><td>Name of subject group. </td></tr> + <tr><td class="paramname">index_field</td><td>Type of index; Possible values are: <ul> +<li>H5_INDEX_UNKNOWN_F = -1 - Unknown index type </li> +<li>H5_INDEX_NAME_F - Index on names </li> +<li>H5_INDEX_CRT_ORDER_F - Index on creation order </li> +<li>H5_INDEX_N_F - Number of indices defined </li> +</ul> +</td></tr> + <tr><td class="paramname">order</td><td>Order within field or index; Possible values are: <ul> +<li>H5_ITER_UNKNOWN_F - Unknown order </li> +<li>H5_ITER_INC_F - Increasing order </li> +<li>H5_ITER_DEC_F - Decreasing order </li> +<li>H5_ITER_NATIVE_F - No particular order, whatever is fastest </li> +<li>H5_ITER_N_F - Number of iteration orders </li> +</ul> +</td></tr> + <tr><td class="paramname">n</td><td>Link for which to retrieve information. </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#ga7dc3198d8cfaeb6a780863af8d0af253">H5Ldelete_by_idx_async()</a> </p> + +</div> +</div> +<a id="gab401110c42ef57285d311b54f8495f4c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab401110c42ef57285d311b54f8495f4c">◆ </a></span>h5ldelete_by_idx_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5ldelete_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>group_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>index_field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>order</em>, </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"><em>n</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Removes the nth link in a group. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>File or group identifier specifying location of subject group. </td></tr> + <tr><td class="paramname">group_name</td><td>Name of subject group. </td></tr> + <tr><td class="paramname">index_field</td><td>Type of index; Possible values are: <ul> +<li>H5_INDEX_UNKNOWN_F = -1 - Unknown index type </li> +<li>H5_INDEX_NAME_F - Index on names </li> +<li>H5_INDEX_CRT_ORDER_F - Index on creation order </li> +<li>H5_INDEX_N_F - Number of indices defined </li> +</ul> +</td></tr> + <tr><td class="paramname">order</td><td>Order within field or index; Possible values are: <ul> +<li>H5_ITER_UNKNOWN_F - Unknown order </li> +<li>H5_ITER_INC_F - Increasing order </li> +<li>H5_ITER_DEC_F - Decreasing order </li> +<li>H5_ITER_NATIVE_F - No particular order, whatever is fastest </li> +<li>H5_ITER_N_F - Number of iteration orders </li> +</ul> +</td></tr> + <tr><td class="paramname">n</td><td>Link for which to retrieve information. </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_l.html#gaaf5f820856afdd34f9070a797a246805">H5Ldelete_by_idx()</a> </p> + +</div> +</div> +<a id="gaed9e00c1376f8c080e1b87a9a2db0abb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaed9e00c1376f8c080e1b87a9a2db0abb">◆ </a></span>h5ldelete_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5ldelete_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Removes a link from a group. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Identifier of the file or group containing the object. </td></tr> + <tr><td class="paramname">name</td><td>Name of the link to delete. </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 identifier.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_l.html#ga5b4e7f59f5d4bdae94fd8ce6875295cf">H5Ldelete()</a> </p> + +</div> +</div> +<a id="ga70e8f9f58e20b3456b2ed530a8554d5b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga70e8f9f58e20b3456b2ed530a8554d5b">◆ </a></span>h5lexists_async_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lexists_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in) </td> + <td class="paramname"><em>link_exists</em>, </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"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>file</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in), optional </td> + <td class="paramname"><em>line</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Asynchronously checks if a link with a particular name exists in a group. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Identifier of the file or group to query. </td></tr> + <tr><td class="paramname">name</td><td>Link name to check. </td></tr> + <tr><td class="paramname">link_exists</td><td>Pointer to link exists status. It should be declared INTEGER(C_INT) and initialized to zero (false) for portability. It will return one when true. LOGICAL(C_BOOL) is also acceptable but may encounter atypical anomalies. It should be initialized to false when used. </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 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#gae33482c2e6df9771dde47ae47874fa18">H5Lexists_async()</a> </p> + +</div> +</div> +<a id="ga33f8908c3915302600d6753a84bd9f82"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga33f8908c3915302600d6753a84bd9f82">◆ </a></span>h5lexists_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lexists_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">logical, intent(out) </td> + <td class="paramname"><em>link_exists</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if a link with a particular name exists in a group. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Identifier of the file or group to query. </td></tr> + <tr><td class="paramname">name</td><td>Link name to check. </td></tr> + <tr><td class="paramname">link_exists</td><td>Link exists status (.TRUE.,.FALSE.). </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 identifier.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_l.html#ga171be6e41dc1a464edc402df0ebdf801">H5Lexists()</a> </p> + +</div> +</div> +<a id="ga2d9b80bf47d989f277ad3b01bcb4af0f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2d9b80bf47d989f277ad3b01bcb4af0f">◆ </a></span>h5lget_info_by_idx_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lget_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>group_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>index_field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>order</em>, </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"><em>n</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>link_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">logical, intent(out) </td> + <td class="paramname"><em>f_corder_valid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>corder</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>cset</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(<a class="el" href="structh5global_1_1h5o__token__t__f.html">h5o_token_t_f</a>), intent(out), target </td> + <td class="paramname"><em>token</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(out) </td> + <td class="paramname"><em>val_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves metadata for a link in a group, according to the order within a field or index. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>File or group identifier specifying location of subject group. </td></tr> + <tr><td class="paramname">group_name</td><td>Name of subject group. </td></tr> + <tr><td class="paramname">index_field</td><td>Index or field which determines the order: <ul> +<li>H5_INDEX_UNKNOWN_F = -1 - Unknown index type </li> +<li>H5_INDEX_NAME_F - Index on names </li> +<li>H5_INDEX_CRT_ORDER_F - Index on creation order </li> +<li>H5_INDEX_N_F - Number of indices defined </li> +</ul> +</td></tr> + <tr><td class="paramname">order</td><td>Order within field or index: <ul> +<li>H5_ITER_UNKNOWN_F - Unknown order </li> +<li>H5_ITER_INC_F - Increasing order </li> +<li>H5_ITER_DEC_F - Decreasing order </li> +<li>H5_ITER_NATIVE_F - No particular order, whatever is fastest </li> +<li>H5_ITER_N_F - Number of iteration orders </li> +</ul> +</td></tr> + <tr><td class="paramname">n</td><td>Link for which to retrieve information. NOTE: In C these are defined as a structure: H5L_info_t </td></tr> + <tr><td class="paramname">link_type</td><td>Specifies the link class: <ul> +<li>H5L_TYPE_HARD_F - Hard link </li> +<li>H5L_TYPE_SOFT_F - Soft link </li> +<li>H5L_TYPE_EXTERNAL_F - External link </li> +<li>H5L_TYPE_ERROR _F - Error </li> +</ul> +</td></tr> + <tr><td class="paramname">f_corder_valid</td><td>Indicates whether the creation order data is valid for this attribute. </td></tr> + <tr><td class="paramname">corder</td><td>Is a positive integer containing the creation order of the attribute. </td></tr> + <tr><td class="paramname">cset</td><td>Indicates the character set used for the attribute's name. </td></tr> + <tr><td class="paramname">token</td><td>If the link is a hard link, token specifies the object token that the link points to. </td></tr> + <tr><td class="paramname">val_size</td><td>If the link is a symbolic link, val_size will be the length of the link value, e.g., the length of the name of the pointed-to object with a null terminator. </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_l.html#gaecfb3ef8520e9224b24a151ff8459ba9">H5Lget_info_by_idx2()</a> </p> + +</div> +</div> +<a id="ga3ff434a804014217c9ba96d98c95aa75"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3ff434a804014217c9ba96d98c95aa75">◆ </a></span>h5lget_info_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lget_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"><em>link_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>link_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>cset</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>corder</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">logical, intent(out) </td> + <td class="paramname"><em>f_corder_valid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>link_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(<a class="el" href="structh5global_1_1h5o__token__t__f.html">h5o_token_t_f</a>), intent(out), target </td> + <td class="paramname"><em>token</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(out) </td> + <td class="paramname"><em>val_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns information about a link. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">link_loc_id</td><td>File or group identifier. </td></tr> + <tr><td class="paramname">link_name</td><td>Name of the link for which information is being sought. NOTE: In C these are contained in the structure H5L_info_t </td></tr> + <tr><td class="paramname">cset</td><td>Indicates the character set used for link's name. </td></tr> + <tr><td class="paramname">corder</td><td>Specifies the link's creation order position. </td></tr> + <tr><td class="paramname">f_corder_valid</td><td>Indicates whether the value in corder is valid. </td></tr> + <tr><td class="paramname">link_type</td><td>Specifies the link class: <ul> +<li>H5L_TYPE_HARD_F - Hard link </li> +<li>H5L_TYPE_SOFT_F - Soft link </li> +<li>H5L_TYPE_EXTERNAL_F - External link </li> +<li>H5L_TYPE_ERROR_ F - Error </li> +</ul> +</td></tr> + <tr><td class="paramname">token</td><td>If the link is a hard link, token specifies the object token that the link points to. </td></tr> + <tr><td class="paramname">val_size</td><td>If the link is a symbolic link, val_size will be the length of the link value, e.g., the length of the name of the pointed-to object with a null terminator. </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_l.html#ga65e63c6e880fd0183c40486d6748e400">H5Lget_info2()</a> </p> + +</div> +</div> +<a id="ga99aa9227eaada35260ad838b8ed62659"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga99aa9227eaada35260ad838b8ed62659">◆ </a></span>h5lget_name_by_idx_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lget_name_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>group_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>index_field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>order</em>, </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"><em>n</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(out) </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(out), optional </td> + <td class="paramname"><em>size</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves name of the nth link in a group, according to the order within a specified field or index. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>File or group identifier specifying location of subject group. </td></tr> + <tr><td class="paramname">group_name</td><td>Name of subject group. </td></tr> + <tr><td class="paramname">index_field</td><td>Index or field which determines the order: <ul> +<li>H5_INDEX_UNKNOWN_F = -1 - Unknown index type </li> +<li>H5_INDEX_NAME_F - Index on names </li> +<li>H5_INDEX_CRT_ORDER_F - Index on creation order </li> +<li>H5_INDEX_N_F - Number of indices defined </li> +</ul> +</td></tr> + <tr><td class="paramname">order</td><td>Order within field or index: <ul> +<li>H5_ITER_UNKNOWN_F - Unknown order </li> +<li>H5_ITER_INC_F - Increasing order </li> +<li>H5_ITER_DEC_F - Decreasing order </li> +<li>H5_ITER_NATIVE_F - No particular order, whatever is fastest </li> +<li>H5_ITER_N_F - Number of iteration orders </li> +</ul> +</td></tr> + <tr><td class="paramname">n</td><td>Link for which to retrieve information. </td></tr> + <tr><td class="paramname">name</td><td>Buffer in which link value 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>List access property list identifier. </td></tr> + <tr><td class="paramname">size</td><td>Maximum number of characters of link value to be returned.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_l.html#ga453ea40c3bb85ec8120dd17deed2bd90">H5Lget_name_by_idx()</a> </p> + +</div> +</div> +<a id="ga83751f44c400576d675a3f293e515209"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga83751f44c400576d675a3f293e515209">◆ </a></span>h5lis_registered_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lis_registered_f </td> + <td>(</td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>link_cls_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">logical, intent(out) </td> + <td class="paramname"><em>registered</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determines whether a class of user-defined links is registered. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">link_cls_id</td><td>User-defined link class identifier. </td></tr> + <tr><td class="paramname">registered</td><td>.TRUE. if the link class has been registered. </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_l_a.html#ga02c1cf38efea97d18e5e2f65df3f08a2">H5Lis_registered()</a> </p> + +</div> +</div> +<a id="gad790e4fc4a233cf25d8be763cb620c53"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad790e4fc4a233cf25d8be763cb620c53">◆ </a></span>h5literate_async_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5literate_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"><em>group_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>order</em>, </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(inout) </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_funptr), intent(in) </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in) </td> + <td class="paramname"><em>op_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>return_value</em>, </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"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>file</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in), optional </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in), optional </td> + <td class="paramname"><em>line</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Asynchronously iterates through links in a group. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">group_id</td><td>Identifier specifying subject group. </td></tr> + <tr><td class="paramname">idx_type</td><td>Type of index which determines the order: <ul> +<li>H5_INDEX_NAME_F - Alphanumeric index on name </li> +<li>H5_INDEX_CRT_ORDER_F - Index on creation order </li> +</ul> +</td></tr> + <tr><td class="paramname">order</td><td>Order within index: <ul> +<li>H5_ITER_INC_F - Increasing order </li> +<li>H5_ITER_DEC_F - Decreasing order </li> +<li>H5_ITER_NATIVE_F - Fastest available order </li> +</ul> +</td></tr> + <tr><td class="paramname">idx</td><td>Iteration position at which to start, or <br /> + Position at which an interrupted iteration may be restarted </td></tr> + <tr><td class="paramname">op</td><td>Callback function passing data regarding the link to the calling application. </td></tr> + <tr><td class="paramname">op_data</td><td>User-defined pointer to data required by the application for its processing of the link. </td></tr> + <tr><td class="paramname">return_value</td><td>N/A</td></tr> + </table> + </dd> +</dl> +<dl class="section warning"><dt>Warning</dt><dd>The returned value of the callback routine op will not be set in <code>return_value</code> for H5Literate_async_f(), so <code>return_value</code> should not be used for determining the return state of the callback routine.</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <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#ga0f56b7243d036cdeb5280d8c41f2436e">H5Literate_async()</a> </p> + +</div> +</div> +<a id="ga79959b5c280fefeee6a9a4fd890e3918"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga79959b5c280fefeee6a9a4fd890e3918">◆ </a></span>h5literate_by_name_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5literate_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>group_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>index_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>order</em>, </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(inout) </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_funptr), intent(in) </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in) </td> + <td class="paramname"><em>op_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>return_value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Iterates through links in a group. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>File or group identifier specifying location of subject group. </td></tr> + <tr><td class="paramname">group_name</td><td>Name of subject group. </td></tr> + <tr><td class="paramname">index_type</td><td>Type of index which determines the order: <ul> +<li>H5_INDEX_NAME_F - Alphanumeric index on name </li> +<li>H5_INDEX_CRT_ORDER_F - Index on creation order </li> +</ul> +</td></tr> + <tr><td class="paramname">order</td><td>Order within index: <ul> +<li>H5_ITER_INC_F - Increasing order </li> +<li>H5_ITER_DEC_F - Decreasing order </li> +<li>H5_ITER_NATIVE_F - Fastest available order </li> +</ul> +</td></tr> + <tr><td class="paramname">idx</td><td>Iteration position at which to start, or <br /> + Position at which an interrupted iteration may be restarted </td></tr> + <tr><td class="paramname">op</td><td>Callback function passing data regarding the link to the calling application. </td></tr> + <tr><td class="paramname">op_data</td><td>User-defined pointer to data required by the application for its processing of the link. </td></tr> + <tr><td class="paramname">return_value</td><td>Return context: <ul> +<li>Success: The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero. </li> +<li>Failure: Negative if something goes wrong within the library, or the negative value returned by one of the operators. </li> +</ul> +</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___t_r_a_v.html#ga745a65eb516ce40a3be43490aaeb5c5e">H5Literate_by_name2()</a> </p> + +</div> +</div> +<a id="ga26cbb1a84d4dd500df6949d2a4a92e0d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga26cbb1a84d4dd500df6949d2a4a92e0d">◆ </a></span>h5literate_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5literate_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"><em>group_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>order</em>, </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(inout) </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_funptr), intent(in) </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in) </td> + <td class="paramname"><em>op_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>return_value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>$ SUBROUTINE h5lget_val_by_idx_f(loc_id, group_name, index_field, order, n, & $ f_corder_valid, corder, cset, data_size, hdferr, lapl_id) $ IMPLICIT NONE </p> +<p>$ SUBROUTINE h5lget_val_f(link_loc_id, link_name, size, linkval_buff, & $ hdferr, lapl_id) $ IMPLICIT NONE $ SUBROUTINE H5Lregistered_f(version, class_id, comment, create_func, & $ move_func, copy_func, trav_func, del_func, query_func, hdferr) $ IMPLICIT NONE</p> +<p>Iterates through links in a group.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">group_id</td><td>Identifier specifying subject group. </td></tr> + <tr><td class="paramname">idx_type</td><td>Type of index which determines the order: <ul> +<li>H5_INDEX_NAME_F - Alphanumeric index on name </li> +<li>H5_INDEX_CRT_ORDER_F - Index on creation order </li> +</ul> +</td></tr> + <tr><td class="paramname">order</td><td>Order within index: <ul> +<li>H5_ITER_INC_F - Increasing order </li> +<li>H5_ITER_DEC_F - Decreasing order </li> +<li>H5_ITER_NATIVE_F - Fastest available order </li> +</ul> +</td></tr> + <tr><td class="paramname">idx</td><td>Iteration position at which to start, or <br /> + Position at which an interrupted iteration may be restarted </td></tr> + <tr><td class="paramname">op</td><td>Callback function passing data regarding the link to the calling application. </td></tr> + <tr><td class="paramname">op_data</td><td>User-defined pointer to data required by the application for its processing of the link. </td></tr> + <tr><td class="paramname">return_value</td><td>Return context: <ul> +<li>Success: The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero. </li> +<li>Failure: Negative if something goes wrong within the library, or the negative value returned by one of the operators. </li> +</ul> +</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___t_r_a_v.html#gad7ca4206f06b5ada85b6ec5867ec6c73">H5Literate2()</a> </p> + +</div> +</div> +<a id="ga9e0662219e9782d91250ca6627b574b6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9e0662219e9782d91250ca6627b574b6">◆ </a></span>h5lmove_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lmove_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"><em>src_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>src_name</em>, </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"><em>dest_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dest_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lcpl_id</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Renames a link 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 file or group identifier. </td></tr> + <tr><td class="paramname">src_name</td><td>Original link name. </td></tr> + <tr><td class="paramname">dest_loc_id</td><td>Destination file or group identifier. </td></tr> + <tr><td class="paramname">dest_name</td><td>NEW link name. </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails. </td></tr> + <tr><td class="paramname">lcpl_id</td><td>Link creation property list identifier to be associated WITH the NEW link. </td></tr> + <tr><td class="paramname">lapl_id</td><td>Link access property list identifier to be associated WITH the NEW link.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_l.html#ga0bbc7f9bf25c8aca9dd8433a325c8acb">H5Lmove()</a> </p> + +</div> +</div> +<a id="ga8c17b9a759f758374df64b2216dc514f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8c17b9a759f758374df64b2216dc514f">◆ </a></span>h5lvisit_by_name_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lvisit_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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>group_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>order</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_funptr), intent(in) </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(inout) </td> + <td class="paramname"><em>op_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>return_value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em>, </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"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Recursively visits all links starting from a specified 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">group_name</td><td>Group name </td></tr> + <tr><td class="paramname">idx_type</td><td>Index type </td></tr> + <tr><td class="paramname">order</td><td>Iteration order </td></tr> + <tr><td class="paramname">op</td><td>Callback function </td></tr> + <tr><td class="paramname">op_data</td><td>User-defined callback function context </td></tr> + <tr><td class="paramname">return_value</td><td>The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero. </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___t_r_a_v.html#gafee93792c7e27a7e78b1ec221876b173">H5Lvisit_by_name2()</a> </p> + +</div> +</div> +<a id="ga2b70c18c17afcd7ca0509dc12f6e5ef3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2b70c18c17afcd7ca0509dc12f6e5ef3">◆ </a></span>h5lvisit_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5l::h5lvisit_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"><em>grp_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>order</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_funptr), intent(in) </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(inout) </td> + <td class="paramname"><em>op_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>return_value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Recursively visits all links starting from a 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">idx_type</td><td>Index type </td></tr> + <tr><td class="paramname">order</td><td>Iteration order </td></tr> + <tr><td class="paramname">op</td><td>Callback function </td></tr> + <tr><td class="paramname">op_data</td><td>User-defined callback function context </td></tr> + <tr><td class="paramname">return_value</td><td>The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero. </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___t_r_a_v.html#gae1c6f963892a5f4e8922a66fbe338f66">H5Lvisit2()</a> </p> + +</div> +</div> +<h2 class="groupheader">Variable Documentation</h2> +<a id="ga9286668bf707376ba5d7a999c35befee"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9286668bf707376ba5d7a999c35befee">◆ </a></span>h5l_link_class_t_vers_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5l_link_class_t_vers_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5L_LINK_CLASS_T_VERS. </p> + +</div> +</div> +<a id="gaae5ada36912c6d058d219aef3aa18477"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaae5ada36912c6d058d219aef3aa18477">◆ </a></span>h5l_same_loc_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5l_same_loc_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5L_SAME_LOC. </p> + +</div> +</div> +<a id="ga7eb0438f997d467c514e1758350004a3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7eb0438f997d467c514e1758350004a3">◆ </a></span>h5l_type_error_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5l_type_error_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5L_TYPE_ERROR. </p> + +</div> +</div> +<a id="ga2eb38e4b58b76e1fa18d8b884f1cfd26"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2eb38e4b58b76e1fa18d8b884f1cfd26">◆ </a></span>h5l_type_external_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5l_type_external_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5L_TYPE_EXTERNAL. </p> + +</div> +</div> +<a id="ga7f46e8015570c850d46fc2c04462573f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7f46e8015570c850d46fc2c04462573f">◆ </a></span>h5l_type_hard_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5l_type_hard_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5L_TYPE_HARD. </p> + +</div> +</div> +<a id="ga9942d93ab69e3c609f4e2357a93b7ce0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9942d93ab69e3c609f4e2357a93b7ce0">◆ </a></span>h5l_type_soft_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5l_type_soft_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5L_TYPE_SOFT. </p> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + </ul> +</div> +</body> +</html> |