mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-29 04:09:39 +03:00
213 lines
18 KiB
HTML
213 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.7"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>HDF5: h5r Module Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript">var page_layout=1;</script>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
|
|
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
|
|
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">HDF5<span id="projectnumber"> 1.15.0.405d1b9</span>
|
|
</div>
|
|
<div id="projectbrief">API Reference</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.7 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="_getting_started.html"><span>Getting started</span></a></li>
|
|
<li><a href="_u_g.html"><span>User Guide</span></a></li>
|
|
<li><a href="_r_m.html"><span>Reference Manual</span></a></li>
|
|
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
|
|
<li><a href="_t_n.html"><span>Technical Notes</span></a></li>
|
|
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
|
|
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
|
|
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
|
|
<li><a href="_about.html"><span>About</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('namespaceh5r.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Types</a> |
|
|
<a href="#func-members">Functions/Subroutines</a> </div>
|
|
<div class="headertitle"><div class="title">h5r Module Reference<div class="ingroups"><a class="el" href="group___f_h5_r.html">FH5R</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>This module contains Fortran interfaces for H5R functions.
|
|
<a href="namespaceh5r.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Types</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">type  </td><td class="memItemRight" valign="bottom"><a class="el" href="structh5r_1_1h5r__ref__t.html">h5r_ref_t</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceh5r_1_1h5rget__object__type__f.html">h5rget_object_type_f</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">type  </td><td class="memItemRight" valign="bottom"><a class="el" href="structh5r_1_1hdset__reg__ref__t__f03.html">hdset_reg_ref_t_f03</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structh5r_1_1hdset__reg__ref__t__f03.html" title="hdset_reg_ref_t_f03 C compatible reference">hdset_reg_ref_t_f03</a> C compatible reference <a href="structh5r_1_1hdset__reg__ref__t__f03.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions/Subroutines</h2></td></tr>
|
|
<tr class="memitem:ga8261ac60662f627d7ba73721b0c815df"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#ga8261ac60662f627d7ba73721b0c815df">h5rget_object_type_f</a> (dset_id, ref, obj_type, hdferr)</td></tr>
|
|
<tr class="memdesc:ga8261ac60662f627d7ba73721b0c815df"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of object that an object reference points to. <br /></td></tr>
|
|
<tr class="separator:ga8261ac60662f627d7ba73721b0c815df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2f7964fb5d92137e670540c0e9b575d5"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#ga2f7964fb5d92137e670540c0e9b575d5">h5rget_region_f</a> (dset_id, ref, space_id, hdferr)</td></tr>
|
|
<tr class="memdesc:ga2f7964fb5d92137e670540c0e9b575d5"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a dataspace with the specified region selected using pointer. <br /></td></tr>
|
|
<tr class="separator:ga2f7964fb5d92137e670540c0e9b575d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab353c178fef510803be41898fb1cc4fc"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gab353c178fef510803be41898fb1cc4fc">h5rcreate_f</a> (loc_id, name, ref_type, ref, hdferr, space_id)</td></tr>
|
|
<tr class="memdesc:gab353c178fef510803be41898fb1cc4fc"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reference. <br /></td></tr>
|
|
<tr class="separator:gab353c178fef510803be41898fb1cc4fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa74e6c3a73a025cd4872990bbeba2871"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gaa74e6c3a73a025cd4872990bbeba2871">h5rget_name_f</a> (loc_id, ref_type, ref, name, hdferr, size)</td></tr>
|
|
<tr class="memdesc:gaa74e6c3a73a025cd4872990bbeba2871"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a name of a referenced object. <br /></td></tr>
|
|
<tr class="separator:gaa74e6c3a73a025cd4872990bbeba2871"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga923261ee0548ac9dcd7c1cf062453d78"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#ga923261ee0548ac9dcd7c1cf062453d78">h5rget_obj_type_f</a> (loc_id, ref_type, ref, obj_type, hdferr)</td></tr>
|
|
<tr class="memdesc:ga923261ee0548ac9dcd7c1cf062453d78"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of object that an object reference points to. <br /></td></tr>
|
|
<tr class="separator:ga923261ee0548ac9dcd7c1cf062453d78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa10230de290e480ca6133f0a3cd59a4c"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gaa10230de290e480ca6133f0a3cd59a4c">h5ropen_object_f</a> (ref_ptr, obj_id, hdferr, rapl_id, oapl_id)</td></tr>
|
|
<tr class="memdesc:gaa10230de290e480ca6133f0a3cd59a4c"><td class="mdescLeft"> </td><td class="mdescRight">Opens the HDF5 object referenced. <br /></td></tr>
|
|
<tr class="separator:gaa10230de290e480ca6133f0a3cd59a4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3817e98b73008def02a87be60a771835"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#ga3817e98b73008def02a87be60a771835">h5ropen_attr_f</a> (ref_ptr, obj_id, hdferr, rapl_id, aapl_id)</td></tr>
|
|
<tr class="memdesc:ga3817e98b73008def02a87be60a771835"><td class="mdescLeft"> </td><td class="mdescRight">Opens the HDF5 attribute referenced. <br /></td></tr>
|
|
<tr class="separator:ga3817e98b73008def02a87be60a771835"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1510f10e0def7269f7358ebf0c4ff226"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#ga1510f10e0def7269f7358ebf0c4ff226">h5ropen_region_f</a> (ref_ptr, space_id, hdferr, rapl_id, oapl_id)</td></tr>
|
|
<tr class="memdesc:ga1510f10e0def7269f7358ebf0c4ff226"><td class="mdescLeft"> </td><td class="mdescRight">Sets up a dataspace and selection as specified by a region reference. <br /></td></tr>
|
|
<tr class="separator:ga1510f10e0def7269f7358ebf0c4ff226"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf692d97454edf87f2bc5a6882f894041"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gaf692d97454edf87f2bc5a6882f894041">h5rcopy_f</a> (src_ref_ptr, dst_ref_ptr, hdferr)</td></tr>
|
|
<tr class="memdesc:gaf692d97454edf87f2bc5a6882f894041"><td class="mdescLeft"> </td><td class="mdescRight">Copies an existing reference. <br /></td></tr>
|
|
<tr class="separator:gaf692d97454edf87f2bc5a6882f894041"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga63effc2cbe4e86b82b3ba6259f1da5dc"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#ga63effc2cbe4e86b82b3ba6259f1da5dc">h5requal_f</a> (ref1_ptr, ref2_ptr, equal, hdferr)</td></tr>
|
|
<tr class="memdesc:ga63effc2cbe4e86b82b3ba6259f1da5dc"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether two references are equal. <br /></td></tr>
|
|
<tr class="separator:ga63effc2cbe4e86b82b3ba6259f1da5dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacbfe419e0c8216296f441e29e4be3d2a"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gacbfe419e0c8216296f441e29e4be3d2a">h5rget_type_f</a> (ref_ptr, ref_type, hdferr)</td></tr>
|
|
<tr class="memdesc:gacbfe419e0c8216296f441e29e4be3d2a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of a reference. <br /></td></tr>
|
|
<tr class="separator:gacbfe419e0c8216296f441e29e4be3d2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa3747b5b431a931ef99e86b653ac4619"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gaa3747b5b431a931ef99e86b653ac4619">h5rdestroy_f</a> (ref_ptr, hdferr)</td></tr>
|
|
<tr class="memdesc:gaa3747b5b431a931ef99e86b653ac4619"><td class="mdescLeft"> </td><td class="mdescRight">Closes a reference. <br /></td></tr>
|
|
<tr class="separator:gaa3747b5b431a931ef99e86b653ac4619"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5a7793593fd33b470d0c541eb8c98850"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#ga5a7793593fd33b470d0c541eb8c98850">h5rcreate_object_f</a> (loc_id, name, ref, hdferr, oapl_id)</td></tr>
|
|
<tr class="memdesc:ga5a7793593fd33b470d0c541eb8c98850"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reference. <br /></td></tr>
|
|
<tr class="separator:ga5a7793593fd33b470d0c541eb8c98850"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaca221946ff02badd4c386ba4030048e9"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gaca221946ff02badd4c386ba4030048e9">h5rcreate_region_f</a> (loc_id, name, space_id, ref_ptr, hdferr, oapl_id)</td></tr>
|
|
<tr class="memdesc:gaca221946ff02badd4c386ba4030048e9"><td class="mdescLeft"> </td><td class="mdescRight">Creates a region reference. <br /></td></tr>
|
|
<tr class="separator:gaca221946ff02badd4c386ba4030048e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga67b81598bf40440ebdf0b7746b626121"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#ga67b81598bf40440ebdf0b7746b626121">h5rcreate_attr_f</a> (loc_id, name, attr_name, ref_ptr, hdferr, oapl_id)</td></tr>
|
|
<tr class="memdesc:ga67b81598bf40440ebdf0b7746b626121"><td class="mdescLeft"> </td><td class="mdescRight">Creates an attribute reference. <br /></td></tr>
|
|
<tr class="separator:ga67b81598bf40440ebdf0b7746b626121"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa07215d205aac295ed592205c2eee06f"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gaa07215d205aac295ed592205c2eee06f">h5rget_obj_name_f</a> (ref_ptr, name, hdferr, rapl_id, name_len)</td></tr>
|
|
<tr class="memdesc:gaa07215d205aac295ed592205c2eee06f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the object name for a referenced object. <br /></td></tr>
|
|
<tr class="separator:gaa07215d205aac295ed592205c2eee06f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafdd9737f63f077747568c5ea7047b228"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gafdd9737f63f077747568c5ea7047b228">h5rget_attr_name_f</a> (ref_ptr, name, hdferr, name_len)</td></tr>
|
|
<tr class="memdesc:gafdd9737f63f077747568c5ea7047b228"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the attribute name for a referenced object. <br /></td></tr>
|
|
<tr class="separator:gafdd9737f63f077747568c5ea7047b228"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae460bc646327149ec8d296603e90fda9"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_r.html#gae460bc646327149ec8d296603e90fda9">h5rget_file_name_f</a> (ref_ptr, name, hdferr, name_len)</td></tr>
|
|
<tr class="memdesc:gae460bc646327149ec8d296603e90fda9"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the file name for a referenced object. <br /></td></tr>
|
|
<tr class="separator:gae460bc646327149ec8d296603e90fda9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This module contains Fortran interfaces for H5R functions. </p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceh5r.html">h5r</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.7 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|