Files
hdf5/develop/namespaceh5lib.html
T
2024-02-09 17:39:10 +00:00

164 lines
12 KiB
HTML

<!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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: h5lib Module Reference</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>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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>
&#160;<span id="projectnumber">1.15.0.33bb197</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</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>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('namespaceh5lib.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="#func-members">Functions/Subroutines</a> </div>
<div class="headertitle"><div class="title">h5lib Module Reference<div class="ingroups"><a class="el" href="group___f_h5.html">Fortran Library (H5) Interface</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>This module provides fortran specific helper functions for the HDF library.
<a href="#details">More...</a></p>
<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:ga3ca54ba860cf80a39bcaef71484f5baf" id="r_ga3ca54ba860cf80a39bcaef71484f5baf"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga3ca54ba860cf80a39bcaef71484f5baf">h5open_f</a> (error)</td></tr>
<tr class="memdesc:ga3ca54ba860cf80a39bcaef71484f5baf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes HDF5 Fortran interface. <br /></td></tr>
<tr class="separator:ga3ca54ba860cf80a39bcaef71484f5baf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaae21753ce0b3ef8eeb85720ac705d88" id="r_gaaae21753ce0b3ef8eeb85720ac705d88"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#gaaae21753ce0b3ef8eeb85720ac705d88">h5close_f</a> (error)</td></tr>
<tr class="memdesc:gaaae21753ce0b3ef8eeb85720ac705d88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes HDF5 Fortran interface. <br /></td></tr>
<tr class="separator:gaaae21753ce0b3ef8eeb85720ac705d88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93f6117c7d768224ae63c0e380168c3b" id="r_ga93f6117c7d768224ae63c0e380168c3b"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga93f6117c7d768224ae63c0e380168c3b">h5get_libversion_f</a> (majnum, minnum, relnum, error)</td></tr>
<tr class="memdesc:ga93f6117c7d768224ae63c0e380168c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the HDF5 LIbrary release number. <br /></td></tr>
<tr class="separator:ga93f6117c7d768224ae63c0e380168c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga52f34ed77742a854b8ac701a580c2064" id="r_ga52f34ed77742a854b8ac701a580c2064"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga52f34ed77742a854b8ac701a580c2064">h5check_version_f</a> (majnum, minnum, relnum, error)</td></tr>
<tr class="memdesc:ga52f34ed77742a854b8ac701a580c2064"><td class="mdescLeft">&#160;</td><td class="mdescRight">Verifies that library versions are consistent. <br /></td></tr>
<tr class="separator:ga52f34ed77742a854b8ac701a580c2064"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga317ffcf96e04bfdcdce23e7049c414bf" id="r_ga317ffcf96e04bfdcdce23e7049c414bf"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga317ffcf96e04bfdcdce23e7049c414bf">h5garbage_collect_f</a> (error)</td></tr>
<tr class="memdesc:ga317ffcf96e04bfdcdce23e7049c414bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Garbage collects on all free-lists of all types. <br /></td></tr>
<tr class="separator:ga317ffcf96e04bfdcdce23e7049c414bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1c43bfc696f18af3c90eed2cdf65ec45" id="r_ga1c43bfc696f18af3c90eed2cdf65ec45"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga1c43bfc696f18af3c90eed2cdf65ec45">h5dont_atexit_f</a> (error)</td></tr>
<tr class="memdesc:ga1c43bfc696f18af3c90eed2cdf65ec45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instructs library not to install atexit cleanup routine. <br /></td></tr>
<tr class="separator:ga1c43bfc696f18af3c90eed2cdf65ec45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac849cafadb09ed2c3cd9272a4ef8af3c" id="r_gac849cafadb09ed2c3cd9272a4ef8af3c"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#gac849cafadb09ed2c3cd9272a4ef8af3c">h5get_free_list_sizes_f</a> (reg_size, arr_size, blk_size, fac_size, error)</td></tr>
<tr class="memdesc:gac849cafadb09ed2c3cd9272a4ef8af3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current size of the free lists used to manage memory. <br /></td></tr>
<tr class="separator:gac849cafadb09ed2c3cd9272a4ef8af3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0bc892d7536ce3994d3dfcd26ae0a33" id="r_gae0bc892d7536ce3994d3dfcd26ae0a33"><td class="memItemLeft" align="right" valign="top">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>) function, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#gae0bc892d7536ce3994d3dfcd26ae0a33">h5kind_to_type</a> (ikind, flag)</td></tr>
<tr class="memdesc:gae0bc892d7536ce3994d3dfcd26ae0a33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the KIND to the correct HDF type. <br /></td></tr>
<tr class="separator:gae0bc892d7536ce3994d3dfcd26ae0a33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga01e3a81f299b9c9cb4bc088bab795412" id="r_ga01e3a81f299b9c9cb4bc088bab795412"><td class="memItemLeft" align="right" valign="top">integer(size_t) function, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga01e3a81f299b9c9cb4bc088bab795412">h5offsetof</a> (start, end)</td></tr>
<tr class="memdesc:ga01e3a81f299b9c9cb4bc088bab795412"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the offset in memory. <br /></td></tr>
<tr class="separator:ga01e3a81f299b9c9cb4bc088bab795412"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0185de6a71deabb35293843c481925af" id="r_ga0185de6a71deabb35293843c481925af"><td class="memItemLeft" align="right" valign="top">integer function, dimension(1:8), public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga0185de6a71deabb35293843c481925af">h5gmtime</a> (stdtime_t)</td></tr>
<tr class="memdesc:ga0185de6a71deabb35293843c481925af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert time_t structure (C) to Fortran DATE AND TIME storage format. <br /></td></tr>
<tr class="separator:ga0185de6a71deabb35293843c481925af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This module provides fortran specific helper functions for the HDF library. </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="namespaceh5lib.html">h5lib</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.10.0 </li>
</ul>
</div>
</body>
</html>