diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
| commit | 4f20d880c97be1249f8d89ced95f72836dbf3ee0 (patch) | |
| tree | 30d8dcb282134b7126b092796f2be00d2d97bd3c /develop/group___j_h5_f.html | |
| parent | 4e7e457497c948b41c8b0065225875bf10cdf9d4 (diff) | |
| download | hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.zip hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.gz hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.bz2 | |
deploy: ef39882fa1e13740d2530c7a0637bd1f1a822b68
Diffstat (limited to 'develop/group___j_h5_f.html')
| -rw-r--r-- | develop/group___j_h5_f.html | 1621 |
1 files changed, 1621 insertions, 0 deletions
diff --git a/develop/group___j_h5_f.html b/develop/group___j_h5_f.html new file mode 100644 index 0000000..a058d4b --- /dev/null +++ b/develop/group___j_h5_f.html @@ -0,0 +1,1621 @@ +<!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: Java File (H5F) 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.15.0.ef39882</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___j_h5_f.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</a> </div> + <div class="headertitle"> +<div class="title">Java File (H5F) 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_f.html">Files (H5F)</a>, C-API</dd> +<dd> +<a class="el" href="_h5_f__u_g.html">The HDF5 File</a>, User Guide </dd></dl> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gae2af8e1b3fcf6a3a98ab345ed3ff710f"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gae2af8e1b3fcf6a3a98ab345ed3ff710f">H5Fclose</a> (long file_id) throws HDF5LibraryException </td></tr> +<tr class="separator:gae2af8e1b3fcf6a3a98ab345ed3ff710f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaceb23ca3aeaac704f563873d7d516913"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gaceb23ca3aeaac704f563873d7d516913">H5Fopen</a> (String name, int flags, long access_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gaceb23ca3aeaac704f563873d7d516913"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9c4aa7a37c3f96d5a030ab3db9ea6b3c"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga9c4aa7a37c3f96d5a030ab3db9ea6b3c">H5Freopen</a> (long file_id) throws HDF5LibraryException </td></tr> +<tr class="separator:ga9c4aa7a37c3f96d5a030ab3db9ea6b3c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabd29514d186d5ff99f1b7789168b7518"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gabd29514d186d5ff99f1b7789168b7518">H5Fcreate</a> (String name, int flags, long create_id, long access_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gabd29514d186d5ff99f1b7789168b7518"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga68f2950e68242b5cf3f3f16665884098"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga68f2950e68242b5cf3f3f16665884098">H5Fflush</a> (long object_id, int scope) throws HDF5LibraryException</td></tr> +<tr class="separator:ga68f2950e68242b5cf3f3f16665884098"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae6816ee72c5becdedd1795f49302a61a"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gae6816ee72c5becdedd1795f49302a61a">H5Fget_access_plist</a> (long file_id) throws HDF5LibraryException </td></tr> +<tr class="separator:gae6816ee72c5becdedd1795f49302a61a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf552de4e95ababd36503786aa95c5543"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gaf552de4e95ababd36503786aa95c5543">H5Fget_create_plist</a> (long file_id) throws HDF5LibraryException </td></tr> +<tr class="separator:gaf552de4e95ababd36503786aa95c5543"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga93177de1e51f10dd4345af2b18d2ed0a"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga93177de1e51f10dd4345af2b18d2ed0a">H5Fget_filesize</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga93177de1e51f10dd4345af2b18d2ed0a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8eb3b2e26a9665716e3a4dd088c2a110"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga8eb3b2e26a9665716e3a4dd088c2a110">H5Fget_freespace</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga8eb3b2e26a9665716e3a4dd088c2a110"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7fa39e49c4cc79c92417b7975647bce8"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga7fa39e49c4cc79c92417b7975647bce8">H5Fget_intent</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga7fa39e49c4cc79c92417b7975647bce8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0659bd74e6c36b5bcdbce58f435a2471"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga0659bd74e6c36b5bcdbce58f435a2471">H5Fget_fileno</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga0659bd74e6c36b5bcdbce58f435a2471"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga23c530eeff9347e8228838c01dd51bdb"><td class="memItemLeft" align="right" valign="top">static synchronized native double </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga23c530eeff9347e8228838c01dd51bdb">H5Fget_mdc_hit_rate</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga23c530eeff9347e8228838c01dd51bdb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2401fec70096313cfa1f996a07ccb58b"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga2401fec70096313cfa1f996a07ccb58b">H5Fget_mdc_size</a> (long file_id, long[] metadata_cache) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga2401fec70096313cfa1f996a07ccb58b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9251e84d3f5e9519689a199e1ae233fb"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga9251e84d3f5e9519689a199e1ae233fb">H5Fget_name</a> (long obj_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga9251e84d3f5e9519689a199e1ae233fb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad94f5268aff34a268cc172bcdbe14a43"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gad94f5268aff34a268cc172bcdbe14a43">H5Fget_obj_count</a> (long file_id, int types) throws HDF5LibraryException</td></tr> +<tr class="separator:gad94f5268aff34a268cc172bcdbe14a43"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga70587e2bb55050ba6615ff21b14b563f"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga70587e2bb55050ba6615ff21b14b563f">H5Fget_obj_ids</a> (long file_id, int types, long max_objs, long[] obj_id_list) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga70587e2bb55050ba6615ff21b14b563f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadf78bae0122080a4500a7c04b7efe53c"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gadf78bae0122080a4500a7c04b7efe53c">H5Fis_hdf5</a> (String name) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gadf78bae0122080a4500a7c04b7efe53c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga05b017fbde34c50d5ba660f3544287ca"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga05b017fbde34c50d5ba660f3544287ca">H5Fis_accessible</a> (String name, long fapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga05b017fbde34c50d5ba660f3544287ca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9332f0a150de188d9277a372f77d7c81"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga9332f0a150de188d9277a372f77d7c81">H5Fmount</a> (long loc_id, String name, long child_id, long plist_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga9332f0a150de188d9277a372f77d7c81"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0f3ce0599852b2394154c803e91f98dd"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga0f3ce0599852b2394154c803e91f98dd">H5Funmount</a> (long loc_id, String name) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga0f3ce0599852b2394154c803e91f98dd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae886416abdeeaade8d3f1eb208553991"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gae886416abdeeaade8d3f1eb208553991">H5Freset_mdc_hit_rate_stats</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gae886416abdeeaade8d3f1eb208553991"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabb08a4ebe8043343a33e75105a5675b9"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f__info2__t.html">H5F_info2_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gabb08a4ebe8043343a33e75105a5675b9">H5Fget_info</a> (long obj_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gabb08a4ebe8043343a33e75105a5675b9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7dd16adeb51a442715e5d9822792f22b"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga7dd16adeb51a442715e5d9822792f22b">H5Fclear_elink_file_cache</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga7dd16adeb51a442715e5d9822792f22b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4346b5b0ce21586754ae4915524713a2"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga4346b5b0ce21586754ae4915524713a2">H5Fstart_swmr_write</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga4346b5b0ce21586754ae4915524713a2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5a0ba403100708152bf26f065961d57e"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga5a0ba403100708152bf26f065961d57e">H5Fstart_mdc_logging</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga5a0ba403100708152bf26f065961d57e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8018593595e4edd8e7a8a48c58183fbe"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga8018593595e4edd8e7a8a48c58183fbe">H5Fstop_mdc_logging</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga8018593595e4edd8e7a8a48c58183fbe"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafe8dbd62c0bfd59381de2dec03605a2c"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gafe8dbd62c0bfd59381de2dec03605a2c">H5Fget_mdc_logging_status</a> (long file_id, boolean[] mdc_logging_status) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gafe8dbd62c0bfd59381de2dec03605a2c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7bdded58e271dd3950d7ac765930b51c"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#ga7bdded58e271dd3950d7ac765930b51c">H5Fget_dset_no_attrs_hint</a> (long file_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga7bdded58e271dd3950d7ac765930b51c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafdd3023ff5992ddfb76983bc3894894f"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gafdd3023ff5992ddfb76983bc3894894f">H5Fset_dset_no_attrs_hint</a> (long file_id, boolean minimize) throws HDF5LibraryException</td></tr> +<tr class="separator:gafdd3023ff5992ddfb76983bc3894894f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabe7edf4d09ac71c4f8b1135594d691ea"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_f.html#gabe7edf4d09ac71c4f8b1135594d691ea">H5Fset_libver_bounds</a> (long file_id, int low, int high) throws HDF5LibraryException</td></tr> +<tr class="separator:gabe7edf4d09ac71c4f8b1135594d691ea"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="ga7dd16adeb51a442715e5d9822792f22b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7dd16adeb51a442715e5d9822792f22b">◆ </a></span>H5Fclear_elink_file_cache()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Fclear_elink_file_cache </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fclear_elink_file_cache evicts all the cached child files in the specified file's external file cache, causing them to be closed if there is nothing else holding them open.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gae2af8e1b3fcf6a3a98ab345ed3ff710f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae2af8e1b3fcf6a3a98ab345ed3ff710f">◆ </a></span>H5Fclose()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int H5Fclose </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fclose terminates access to an HDF5 file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>Identifier of a file to terminate access to.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gabd29514d186d5ff99f1b7789168b7518"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabd29514d186d5ff99f1b7789168b7518">◆ </a></span>H5Fcreate()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Fcreate </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>create_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>access_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fcreate is the primary function for creating HDF5 files.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">name</td><td>Name of the file to access. </td></tr> + <tr><td class="paramname">flags</td><td>File access flags. Possible values include: <ul> +<li> +<a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a> Allow read and write access to file. </li> +<li> +<a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a> Allow read-only access to file. </li> +<li> +<a class="el" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a> Truncate file, if it already exists, erasing all data previously stored in the file. </li> +<li> +<a class="el" href="_h5_fpublic_8h.html#a7a47250dc1435705233dca7297ba3d90">H5F_ACC_EXCL</a> Fail if file already exists. </li> +<li> +<a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> Apply default file access and creation properties. </li> +</ul> +</td></tr> + <tr><td class="paramname">create_id</td><td>File creation property list identifier, used when modifying default file meta-data. Use H5P_DEFAULT for default access properties. </td></tr> + <tr><td class="paramname">access_id</td><td>File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the access_id (not supported in Java). Use H5P_DEFAULT for default access properties.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a file identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga68f2950e68242b5cf3f3f16665884098"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga68f2950e68242b5cf3f3f16665884098">◆ </a></span>H5Fflush()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Fflush </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>object_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>scope</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fflush causes all buffers associated with a file or object to be immediately flushed (written) to disk without removing the data from the (memory) cache. </p> +<p>After this call completes, the file (or object) is in a consistent state and all data written to date is assured to be permanent.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">object_id</td><td>Identifier of object used to identify the file. <b>object_id</b> can be any object associated with the file, including the file itself, a dataset, a group, an attribute, or a named data type. </td></tr> + <tr><td class="paramname">scope</td><td>specifies the scope of the flushing action, in the case that the HDF5 file is not a single physical file. </td></tr> + </table> + </dd> +</dl> +<p>Valid values are: </p><ul> +<li> +H5F_SCOPE_GLOBAL Flushes the entire virtual file. </li> +<li> +H5F_SCOPE_LOCAL Flushes only the specified file. </li> +</ul> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gae6816ee72c5becdedd1795f49302a61a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae6816ee72c5becdedd1795f49302a61a">◆ </a></span>H5Fget_access_plist()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Fget_access_plist </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_access_plist returns the file access property list identifier of the specified file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>Identifier of file to get access property list of</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a file access property list identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaf552de4e95ababd36503786aa95c5543"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf552de4e95ababd36503786aa95c5543">◆ </a></span>H5Fget_create_plist()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Fget_create_plist </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_create_plist returns a file creation property list identifier identifying the creation properties used to create this file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>Identifier of the file to get creation property list</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a file creation property list identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga7bdded58e271dd3950d7ac765930b51c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7bdded58e271dd3950d7ac765930b51c">◆ </a></span>H5Fget_dset_no_attrs_hint()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Fget_dset_no_attrs_hint </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_dset_no_attrs_hint gets the file-level setting to create minimized dataset object headers.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the file-level is set to create minimized dataset object headers, false if not.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0659bd74e6c36b5bcdbce58f435a2471"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0659bd74e6c36b5bcdbce58f435a2471">◆ </a></span>H5Fget_fileno()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Fget_fileno </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_fileno retrieves the "file number" for an open file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the unique file number for the file.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga93177de1e51f10dd4345af2b18d2ed0a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga93177de1e51f10dd4345af2b18d2ed0a">◆ </a></span>H5Fget_filesize()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Fget_filesize </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_filesize retrieves the file size of the HDF5 file. This function is called after an existing file is opened in order to learn the true size of the underlying file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the file size of the HDF5 file</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga8eb3b2e26a9665716e3a4dd088c2a110"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8eb3b2e26a9665716e3a4dd088c2a110">◆ </a></span>H5Fget_freespace()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Fget_freespace </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_freespace returns the amount of space that is unused by any objects in the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the amount of free space in the file</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gabb08a4ebe8043343a33e75105a5675b9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabb08a4ebe8043343a33e75105a5675b9">◆ </a></span>H5Fget_info()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f__info2__t.html">H5F_info2_t</a> H5Fget_info </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_info returns global information for the file associated with the object identifier obj_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Object identifier for any object in the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A buffer(H5F_info2_t) for current "global" information about file</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga7fa39e49c4cc79c92417b7975647bce8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7fa39e49c4cc79c92417b7975647bce8">◆ </a></span>H5Fget_intent()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Fget_intent </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_intent retrieves the intended access mode flag passed with H5Fopen when the file was opened.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the intended access mode flag, as originally passed with H5Fopen.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga23c530eeff9347e8228838c01dd51bdb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga23c530eeff9347e8228838c01dd51bdb">◆ </a></span>H5Fget_mdc_hit_rate()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native double H5Fget_mdc_hit_rate </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_mdc_hit_rate queries the metadata cache of the target file to obtain its hit rate (cache hits / (cache hits + cache misses)) since the last time hit rate statistics were reset.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the double in which the hit rate is returned.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gafe8dbd62c0bfd59381de2dec03605a2c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafe8dbd62c0bfd59381de2dec03605a2c">◆ </a></span>H5Fget_mdc_logging_status()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Fget_mdc_logging_status </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean[] </td> + <td class="paramname"><em>mdc_logging_status</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_mdc_logging_status gets the current metadata cache logging status.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr> + <tr><td class="paramname">mdc_logging_status</td><td>the status mdc_logging_status[0] = is_enabled, whether logging is enabled mdc_logging_status[1] = is_currently_logging, whether events are currently being logged</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>mdc_logging_status is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga2401fec70096313cfa1f996a07ccb58b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2401fec70096313cfa1f996a07ccb58b">◆ </a></span>H5Fget_mdc_size()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Fget_mdc_size </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>metadata_cache</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_mdc_size queries the metadata cache of the target file for the desired size information.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file. </td></tr> + <tr><td class="paramname">metadata_cache</td><td>OUT: Current metadata cache information <ul> +<li> +metadata_cache[0] = max_size_ptr // current cache maximum size </li> +<li> +metadata_cache[1] = min_clean_size_ptr // current cache minimum clean size </li> +<li> +metadata_cache[2] = cur_size_ptr // current cache size </li> +</ul> +</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>current number of entries in the cache</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>metadata_cache is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9251e84d3f5e9519689a199e1ae233fb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9251e84d3f5e9519689a199e1ae233fb">◆ </a></span>H5Fget_name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native String H5Fget_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_name retrieves the name of the file to which the object obj_id belongs.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object for which the associated filename is sought.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the filename.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gad94f5268aff34a268cc172bcdbe14a43"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad94f5268aff34a268cc172bcdbe14a43">◆ </a></span>H5Fget_obj_count()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Fget_obj_count </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>types</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_obj_count returns the number of open object identifiers for the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file </td></tr> + <tr><td class="paramname">types</td><td>IN: Type of object for which identifiers are to be returned. <ul> +<li> +H5F_OBJ_FILE Files only </li> +<li> +H5F_OBJ_DATASET Datasets only </li> +<li> +H5F_OBJ_GROUP Groups only </li> +<li> +H5F_OBJ_DATATYPE Named datatypes only </li> +<li> +H5F_OBJ_ATTR Attributes only </li> +<li> +H5F_OBJ_ALL All of the above </li> +<li> +H5F_OBJ_LOCAL Restrict search to objects opened through current file identifier. </li> +</ul> +</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of open objects.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga70587e2bb55050ba6615ff21b14b563f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga70587e2bb55050ba6615ff21b14b563f">◆ </a></span>H5Fget_obj_ids()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Fget_obj_ids </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>types</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>max_objs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>obj_id_list</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fget_obj_ids returns the list of identifiers for all open HDF5 objects fitting the specified criteria.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file </td></tr> + <tr><td class="paramname">types</td><td>IN: Type of object for which identifiers are to be returned. </td></tr> + <tr><td class="paramname">max_objs</td><td>IN: Maximum number of object identifiers to place into obj_id_list. </td></tr> + <tr><td class="paramname">obj_id_list</td><td>OUT: Pointer to the returned list of open object identifiers.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of objects placed into obj_id_list.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>obj_id_list is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga05b017fbde34c50d5ba660f3544287ca"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga05b017fbde34c50d5ba660f3544287ca">◆ </a></span>H5Fis_accessible()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Fis_accessible </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>fapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fis_accessible determines if the file can be opened with the given fapl.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">name</td><td>IN: File name to check. </td></tr> + <tr><td class="paramname">fapl_id</td><td>IN: File access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if file is accessible, false if not.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gadf78bae0122080a4500a7c04b7efe53c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadf78bae0122080a4500a7c04b7efe53c">◆ </a></span>H5Fis_hdf5()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Fis_hdf5 </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fis_hdf5 determines whether a file is in the HDF5 format.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">name</td><td>File name to check format.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if is HDF5, false if not.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null.</td></tr> + </table> + </dd> +</dl> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>As of HDF5 1.10.5 in favor of H5Fis_accessible. </dd></dl> + +</div> +</div> +<a id="ga9332f0a150de188d9277a372f77d7c81"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9332f0a150de188d9277a372f77d7c81">◆ </a></span>H5Fmount()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Fmount </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>child_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>plist_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fmount mounts the file specified by child_id onto the group specified by loc_id and name using the mount properties plist_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>The identifier for the group onto which the file specified by child_id is to be mounted. </td></tr> + <tr><td class="paramname">name</td><td>The name of the group onto which the file specified by child_id is to be mounted. </td></tr> + <tr><td class="paramname">child_id</td><td>The identifier of the file to be mounted. </td></tr> + <tr><td class="paramname">plist_id</td><td>The identifier of the property list to be used.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaceb23ca3aeaac704f563873d7d516913"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaceb23ca3aeaac704f563873d7d516913">◆ </a></span>H5Fopen()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Fopen </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>access_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fopen opens an existing file and is the primary function for accessing existing HDF5 files.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">name</td><td>Name of the file to access. </td></tr> + <tr><td class="paramname">flags</td><td>File access flags. </td></tr> + <tr><td class="paramname">access_id</td><td>Identifier for the file access properties list.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a file identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9c4aa7a37c3f96d5a030ab3db9ea6b3c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9c4aa7a37c3f96d5a030ab3db9ea6b3c">◆ </a></span>H5Freopen()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Freopen </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Freopen reopens an HDF5 file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>Identifier of a file to terminate and reopen access to.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a new file identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gae886416abdeeaade8d3f1eb208553991"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae886416abdeeaade8d3f1eb208553991">◆ </a></span>H5Freset_mdc_hit_rate_stats()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Freset_mdc_hit_rate_stats </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Freset_mdc_hit_rate_stats resets the hit rate statistics counters in the metadata cache associated with the specified file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gafdd3023ff5992ddfb76983bc3894894f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafdd3023ff5992ddfb76983bc3894894f">◆ </a></span>H5Fset_dset_no_attrs_hint()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Fset_dset_no_attrs_hint </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>minimize</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fset_dset_no_attrs_hint sets the file-level setting to create minimized dataset object headers.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file. </td></tr> + <tr><td class="paramname">minimize</td><td>the minimize hint setting</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gabe7edf4d09ac71c4f8b1135594d691ea"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabe7edf4d09ac71c4f8b1135594d691ea">◆ </a></span>H5Fset_libver_bounds()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Fset_libver_bounds </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>low</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>high</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fset_libver_bounds sets a different low and high bounds while a file is open.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file. </td></tr> + <tr><td class="paramname">low</td><td>IN: The earliest version of the library that will be used for writing objects </td></tr> + <tr><td class="paramname">high</td><td>IN: The latest version of the library that will be used for writing objects.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga5a0ba403100708152bf26f065961d57e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5a0ba403100708152bf26f065961d57e">◆ </a></span>H5Fstart_mdc_logging()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Fstart_mdc_logging </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fstart_mdc_logging starts logging metadata cache events if logging was previously enabled.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga4346b5b0ce21586754ae4915524713a2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4346b5b0ce21586754ae4915524713a2">◆ </a></span>H5Fstart_swmr_write()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Fstart_swmr_write </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fstart_swmr_write will activate SWMR writing mode for a file associated with file_id. This routine will prepare and ensure the file is safe for SWMR writing.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga8018593595e4edd8e7a8a48c58183fbe"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8018593595e4edd8e7a8a48c58183fbe">◆ </a></span>H5Fstop_mdc_logging()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Fstop_mdc_logging </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Fstop_mdc_logging stops logging metadata cache events if logging was previously enabled and is currently ongoing.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0f3ce0599852b2394154c803e91f98dd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0f3ce0599852b2394154c803e91f98dd">◆ </a></span>H5Funmount()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Funmount </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Given a mount point, H5Funmount disassociates the mount point's file from the file mounted there.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>The identifier for the location at which the specified file is to be unmounted. </td></tr> + <tr><td class="paramname">name</td><td>The name of the file to be unmounted.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</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> |