Files
hdf5/develop/namespaceh5lib.html
T
2023-12-05 00:41:25 +00:00

160 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.9.1"/>
<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>
<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&amp;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>
&#160;<span id="projectnumber">1.15.0.2a43372</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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(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">
<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> </div>
<div class="headertitle">
<div class="title">h5lib Module Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This module provides fortran specific helper functions for the HDF library.
<a href="namespaceh5lib.html#details">More...</a></p>
<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:ga041e8ea7a216ab58ddc59bf6751393d6"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga041e8ea7a216ab58ddc59bf6751393d6">h5open_f</a> (error)</td></tr>
<tr class="memdesc:ga041e8ea7a216ab58ddc59bf6751393d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes HDF5 Fortran interface. <a href="group___f_h5.html#ga041e8ea7a216ab58ddc59bf6751393d6">More...</a><br /></td></tr>
<tr class="separator:ga041e8ea7a216ab58ddc59bf6751393d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga44774afab361ee25be7eda5b6fc86374"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga44774afab361ee25be7eda5b6fc86374">h5close_f</a> (error)</td></tr>
<tr class="memdesc:ga44774afab361ee25be7eda5b6fc86374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes HDF5 Fortran interface. <a href="group___f_h5.html#ga44774afab361ee25be7eda5b6fc86374">More...</a><br /></td></tr>
<tr class="separator:ga44774afab361ee25be7eda5b6fc86374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab18cab915418e6e572756ab9b200031"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#gaab18cab915418e6e572756ab9b200031">h5get_libversion_f</a> (majnum, minnum, relnum, error)</td></tr>
<tr class="memdesc:gaab18cab915418e6e572756ab9b200031"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the HDF5 LIbrary release number. <a href="group___f_h5.html#gaab18cab915418e6e572756ab9b200031">More...</a><br /></td></tr>
<tr class="separator:gaab18cab915418e6e572756ab9b200031"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b2269fe36d781cf9ef53e0151a7cf56"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga4b2269fe36d781cf9ef53e0151a7cf56">h5check_version_f</a> (majnum, minnum, relnum, error)</td></tr>
<tr class="memdesc:ga4b2269fe36d781cf9ef53e0151a7cf56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Verifies that library versions are consistent. <a href="group___f_h5.html#ga4b2269fe36d781cf9ef53e0151a7cf56">More...</a><br /></td></tr>
<tr class="separator:ga4b2269fe36d781cf9ef53e0151a7cf56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ff85c28077d0144c070ea33db4195a9"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga9ff85c28077d0144c070ea33db4195a9">h5garbage_collect_f</a> (error)</td></tr>
<tr class="memdesc:ga9ff85c28077d0144c070ea33db4195a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Garbage collects on all free-lists of all types. <a href="group___f_h5.html#ga9ff85c28077d0144c070ea33db4195a9">More...</a><br /></td></tr>
<tr class="separator:ga9ff85c28077d0144c070ea33db4195a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad2d3df220c5d082c85a33b29c624dc8e"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#gad2d3df220c5d082c85a33b29c624dc8e">h5dont_atexit_f</a> (error)</td></tr>
<tr class="memdesc:gad2d3df220c5d082c85a33b29c624dc8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instructs library not to install atexit cleanup routine. <a href="group___f_h5.html#gad2d3df220c5d082c85a33b29c624dc8e">More...</a><br /></td></tr>
<tr class="separator:gad2d3df220c5d082c85a33b29c624dc8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga40074aa3786e8d774c6c9596f6015a66"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5.html#ga40074aa3786e8d774c6c9596f6015a66">h5get_free_list_sizes_f</a> (reg_size, arr_size, blk_size, fac_size, error)</td></tr>
<tr class="memdesc:ga40074aa3786e8d774c6c9596f6015a66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current size of the free lists used to manage memory. <a href="group___f_h5.html#ga40074aa3786e8d774c6c9596f6015a66">More...</a><br /></td></tr>
<tr class="separator:ga40074aa3786e8d774c6c9596f6015a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad79ebbb1056c05aea50fcab55538a260"><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#gad79ebbb1056c05aea50fcab55538a260">h5kind_to_type</a> (ikind, flag)</td></tr>
<tr class="memdesc:gad79ebbb1056c05aea50fcab55538a260"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the KIND to the correct HDF type. <a href="group___f_h5.html#gad79ebbb1056c05aea50fcab55538a260">More...</a><br /></td></tr>
<tr class="separator:gad79ebbb1056c05aea50fcab55538a260"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3e7bfe233bbc1dbac18dda0a0e41b5b0"><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#ga3e7bfe233bbc1dbac18dda0a0e41b5b0">h5offsetof</a> (start, end)</td></tr>
<tr class="memdesc:ga3e7bfe233bbc1dbac18dda0a0e41b5b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the offset in memory. <a href="group___f_h5.html#ga3e7bfe233bbc1dbac18dda0a0e41b5b0">More...</a><br /></td></tr>
<tr class="separator:ga3e7bfe233bbc1dbac18dda0a0e41b5b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac24bda244b85350dd5ef56236d17dd7a"><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#gac24bda244b85350dd5ef56236d17dd7a">h5gmtime</a> (stdtime_t)</td></tr>
<tr class="memdesc:gac24bda244b85350dd5ef56236d17dd7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert time_t structure (C) to Fortran DATE AND TIME storage format. <a href="group___f_h5.html#gac24bda244b85350dd5ef56236d17dd7a">More...</a><br /></td></tr>
<tr class="separator:gac24bda244b85350dd5ef56236d17dd7a"><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.9.1 </li>
</ul>
</div>
</body>
</html>