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___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___h5_f.html')
| -rw-r--r-- | develop/group___h5_f.html | 2091 |
1 files changed, 2091 insertions, 0 deletions
diff --git a/develop/group___h5_f.html b/develop/group___h5_f.html new file mode 100644 index 0000000..9878f47 --- /dev/null +++ b/develop/group___h5_f.html @@ -0,0 +1,2091 @@ +<!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: Files (H5F)</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___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="#groups">Modules</a> | +<a href="#define-members">Macros</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Files (H5F)</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>Use the functions in this module to manage HDF5 files.</p> +<p>In the code snippets below, we show the skeletal life cycle of an HDF5 file, when creating a new file (left) or when opening an existing file (right). File creation is essentially controlled through <a class="el" href="group___f_c_p_l.html">File Creation Properties</a>, and file access to new and existing files is controlled through <a class="el" href="group___f_a_p_l.html">File Access Properties</a>. The file <code>name</code> and creation or access <code>mode</code> control the interaction with the underlying storage such as file systems.</p> +<table class="doxtable"> +<tr> +<th>Create</th><th>Read </th></tr> +<tr valign="top"> +<td><div class="fragment"><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  {</div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  __label__ fail_fapl, fail_fcpl, fail_file;</div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fcpl, fapl, file;</div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keywordflow">if</span> ((fcpl = <a class="code" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code" href="_h5_ppublic_8h.html#a206f334f1e6c973e1215a3148b45b977">H5P_FILE_CREATE</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  ret_val = EXIT_FAILURE;</div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordflow">goto</span> fail_fcpl;</div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  }</div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordflow">else</span> {</div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="comment">// adjust the file creation properties</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  }</div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">if</span> ((fapl = <a class="code" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code" href="_h5_ppublic_8h.html#a60ec2d4334addfc0eda89614598ee38e">H5P_FILE_ACCESS</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  ret_val = EXIT_FAILURE;</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">goto</span> fail_fapl;</div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  }</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">else</span> {</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// adjust the file access properties</span></div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  }</div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">unsigned</span> mode = <a class="code" href="_h5_fpublic_8h.html#a7a47250dc1435705233dca7297ba3d90">H5F_ACC_EXCL</a>;</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">char</span> name[] = <span class="stringliteral">"f1.h5"</span>;</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">if</span> ((file = <a class="code" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a>(name, mode, fcpl, fapl)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  ret_val = EXIT_FAILURE;</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">goto</span> fail_file;</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// do something useful with FILE</span></div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> fail_file:</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(fapl);</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> fail_fapl:</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(fcpl);</div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> fail_fcpl:;</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div> +<div class="ttc" id="a_h5_fpublic_8h_html_a7a47250dc1435705233dca7297ba3d90"><div class="ttname"><a href="_h5_fpublic_8h.html#a7a47250dc1435705233dca7297ba3d90">H5F_ACC_EXCL</a></div><div class="ttdeci">#define H5F_ACC_EXCL</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:51</div></div> +<div class="ttc" id="a_h5_ipublic_8h_html_a0045db7ff9c22ad35db6ae91662e1943"><div class="ttname"><a href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></div><div class="ttdeci">int64_t hid_t</div><div class="ttdef"><b>Definition:</b> H5Ipublic.h:60</div></div> +<div class="ttc" id="a_h5_ipublic_8h_html_a01eab13dccc91afd6909d74dccb780ba"><div class="ttname"><a href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a></div><div class="ttdeci">#define H5I_INVALID_HID</div><div class="ttdef"><b>Definition:</b> H5Ipublic.h:75</div></div> +<div class="ttc" id="a_h5_ppublic_8h_html_a206f334f1e6c973e1215a3148b45b977"><div class="ttname"><a href="_h5_ppublic_8h.html#a206f334f1e6c973e1215a3148b45b977">H5P_FILE_CREATE</a></div><div class="ttdeci">#define H5P_FILE_CREATE</div><div class="ttdef"><b>Definition:</b> H5Ppublic.h:51</div></div> +<div class="ttc" id="a_h5_ppublic_8h_html_a60ec2d4334addfc0eda89614598ee38e"><div class="ttname"><a href="_h5_ppublic_8h.html#a60ec2d4334addfc0eda89614598ee38e">H5P_FILE_ACCESS</a></div><div class="ttdeci">#define H5P_FILE_ACCESS</div><div class="ttdef"><b>Definition:</b> H5Ppublic.h:52</div></div> +<div class="ttc" id="agroup___h5_f_html_gac55cd91d80822e4f8c2a7f04ea71b124"><div class="ttname"><a href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a></div><div class="ttdeci">herr_t H5Fclose(hid_t file_id)</div><div class="ttdoc">Terminates access to an HDF5 file.</div></div> +<div class="ttc" id="agroup___h5_f_html_gae64b51ee9ac0781bc4ccc599d98387f4"><div class="ttname"><a href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a></div><div class="ttdeci">hid_t H5Fcreate(const char *filename, unsigned flags, hid_t fcpl_id, hid_t fapl_id)</div><div class="ttdoc">Creates an HDF5 file.</div></div> +<div class="ttc" id="agroup___p_l_c_r_html_ga5dce61149211d3ef319452aa598887fb"><div class="ttname"><a href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a></div><div class="ttdeci">herr_t H5Pclose(hid_t plist_id)</div><div class="ttdoc">Terminates access to a property list.</div></div> +<div class="ttc" id="agroup___p_l_c_r_html_gaf1b11da01d4d45d788c45f8bc5f0cbfa"><div class="ttname"><a href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a></div><div class="ttdeci">hid_t H5Pcreate(hid_t cls_id)</div><div class="ttdoc">Creates a new property list as an instance of a property list class.</div></div> +</div><!-- fragment --> </td><td><div class="fragment"><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  __label__ fail_fapl, fail_file;</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl, file;</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> size;</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">if</span> ((fapl = <a class="code" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code" href="_h5_ppublic_8h.html#a60ec2d4334addfc0eda89614598ee38e">H5P_FILE_ACCESS</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  ret_val = EXIT_FAILURE;</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">goto</span> fail_fapl;</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">else</span> {</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// adjust the file access properties</span></div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">unsigned</span> mode = <a class="code" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>;</div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">char</span> name[] = <span class="stringliteral">"f1.h5"</span>;</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> ((file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(name, mode, fapl)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  ret_val = EXIT_FAILURE;</div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">goto</span> fail_file;</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">if</span> (<a class="code" href="group___h5_f.html#ga515426821321c261a825b4e4a3f576fe">H5Fget_filesize</a>(file, &size) < 0) {</div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  ret_val = EXIT_FAILURE;</div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  printf(<span class="stringliteral">"File size: %llu bytes\n"</span>, size);</div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> fail_file:</div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(fapl);</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> fail_fapl:;</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div> +<div class="ttc" id="a_h5_fpublic_8h_html_a1c406ffa89f4acf5a332144a2683d394"><div class="ttname"><a href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a></div><div class="ttdeci">#define H5F_ACC_RDONLY</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:48</div></div> +<div class="ttc" id="a_h5public_8h_html_a7f81cce70fb546af88da24d9285d3c1c"><div class="ttname"><a href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></div><div class="ttdeci">uint64_t hsize_t</div><div class="ttdef"><b>Definition:</b> H5public.h:297</div></div> +<div class="ttc" id="agroup___h5_f_html_ga515426821321c261a825b4e4a3f576fe"><div class="ttname"><a href="group___h5_f.html#ga515426821321c261a825b4e4a3f576fe">H5Fget_filesize</a></div><div class="ttdeci">herr_t H5Fget_filesize(hid_t file_id, hsize_t *size)</div><div class="ttdoc">Returns the size of an HDF5 file (in bytes)</div></div> +<div class="ttc" id="agroup___h5_f_html_gaa3f4f877b9bb591f3880423ed2bf44bc"><div class="ttname"><a href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a></div><div class="ttdeci">hid_t H5Fopen(const char *filename, unsigned flags, hid_t fapl_id)</div><div class="ttdoc">Opens an existing HDF5 file.</div></div> +</div><!-- fragment --> </td></tr> +<tr> +<th>Update</th><th>Delete </th></tr> +<tr valign="top"> +<td><div class="fragment"><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  {</div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  __label__ fail_file;</div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file;</div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">unsigned</span> mode = <a class="code" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>;</div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">char</span> name[] = <span class="stringliteral">"f1.h5"</span>;</div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">if</span> ((file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(name, mode, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  ret_val = EXIT_FAILURE;</div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">goto</span> fail_file;</div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  }</div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="comment">// create a cycle by hard linking the root group in the root group</span></div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">if</span> (<a class="code" href="group___h5_l.html#ga69d50f7acdfd2f1dc7c4372397e63bd2">H5Lcreate_hard</a>(file, <span class="stringliteral">"."</span>, file, <span class="stringliteral">"loopback"</span>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) < 0) {</div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  ret_val = EXIT_FAILURE;</div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> fail_file:;</div> +<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  }</div> +<div class="ttc" id="a_h5_fpublic_8h_html_a402673dec5c537b27a49a9a8bd6140b4"><div class="ttname"><a href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a></div><div class="ttdeci">#define H5F_ACC_RDWR</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:49</div></div> +<div class="ttc" id="a_h5_ppublic_8h_html_afa85e97bfbf9bf1c58e39263846c568f"><div class="ttname"><a href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a></div><div class="ttdeci">#define H5P_DEFAULT</div><div class="ttdef"><b>Definition:</b> H5Ppublic.h:102</div></div> +<div class="ttc" id="agroup___h5_l_html_ga69d50f7acdfd2f1dc7c4372397e63bd2"><div class="ttname"><a href="group___h5_l.html#ga69d50f7acdfd2f1dc7c4372397e63bd2">H5Lcreate_hard</a></div><div class="ttdeci">herr_t H5Lcreate_hard(hid_t cur_loc, const char *cur_name, hid_t dst_loc, const char *dst_name, hid_t lcpl_id, hid_t lapl_id)</div><div class="ttdoc">Creates a hard link to an object.</div></div> +</div><!-- fragment --> </td><td><div class="fragment"><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  {</div> +<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="preprocessor">#if H5_VERSION_GE(1, 12, 0)</span></div> +<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  </div> +<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="comment">// this function is only available in HDF5 1.12.x</span></div> +<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordflow">if</span> (<a class="code" href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62">H5Fdelete</a>(<span class="stringliteral">"f1.h5"</span>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) < 0) {</div> +<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  ret_val = EXIT_FAILURE;</div> +<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  }</div> +<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  </div> +<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  }</div> +<div class="ttc" id="agroup___h5_f_html_ga2e8b5e19b343123e8ab21442f9169a62"><div class="ttname"><a href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62">H5Fdelete</a></div><div class="ttdeci">herr_t H5Fdelete(const char *filename, hid_t fapl_id)</div><div class="ttdoc">Deletes an HDF5 file.</div></div> +</div><!-- fragment --> </td></tr> +</table> +<p>In addition to general file management functions, there are three categories of functions that deal with advanced file management tasks and use cases:</p><ol type="1"> +<li>The control of the HDF5 <a class="el" href="group___m_d_c.html">Metadata Cache</a></li> +<li>The use of (MPI-) <a class="el" href="group___p_h5_f.html">Parallel</a> HDF5</li> +<li>The <a class="el" href="group___s_w_m_r.html">Single Writer Multiple Readers</a> pattern </li> +</ol> +<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Files (H5F):</div> +<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-0-content" class="dyncontent" style="display:none;"> +<div class="center"><img src="group___h5_f.png" border="0" usemap="#agroup______h5__f" alt=""/></div> +<map name="agroup______h5__f" id="agroup______h5__f"> +<area shape="rect" title=" " alt="" coords="5,70,97,95"/> +<area shape="rect" href="group___s_w_m_r.html" title=" " alt="" coords="145,5,308,45"/> +<area shape="rect" href="group___m_d_c.html" title=" " alt="" coords="163,70,291,95"/> +<area shape="rect" href="group___p_h5_f.html" title=" " alt="" coords="191,119,262,145"/> +</map> +</div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> +Modules</h2></td></tr> +<tr class="memitem:group___m_d_c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_d_c.html">Metadata Cache</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group___p_h5_f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_h5_f.html">Parallel</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group___s_w_m_r"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_w_m_r.html">Single Writer Multiple Readers</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:gae17036b3e36a8777328204e8bf073144"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gae17036b3e36a8777328204e8bf073144">H5Fget_info</a>   <a class="el" href="group___h5_f.html#gaced8c09c1559636a9c3f33dff3f4520e">H5Fget_info2</a></td></tr> +<tr class="separator:gae17036b3e36a8777328204e8bf073144"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ga584471c3b98453b9b04a4bf9af847442"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga584471c3b98453b9b04a4bf9af847442">H5Fis_accessible</a> (const char *container_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id)</td></tr> +<tr class="memdesc:ga584471c3b98453b9b04a4bf9af847442"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a file can be opened with a given file access property list. <a href="group___h5_f.html#ga584471c3b98453b9b04a4bf9af847442">More...</a><br /></td></tr> +<tr class="separator:ga584471c3b98453b9b04a4bf9af847442"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae64b51ee9ac0781bc4ccc599d98387f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a> (const char *filename, unsigned flags, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id)</td></tr> +<tr class="memdesc:gae64b51ee9ac0781bc4ccc599d98387f4"><td class="mdescLeft"> </td><td class="mdescRight">Creates an HDF5 file. <a href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">More...</a><br /></td></tr> +<tr class="separator:gae64b51ee9ac0781bc4ccc599d98387f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa3f4f877b9bb591f3880423ed2bf44bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a> (const char *filename, unsigned flags, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id)</td></tr> +<tr class="memdesc:gaa3f4f877b9bb591f3880423ed2bf44bc"><td class="mdescLeft"> </td><td class="mdescRight">Opens an existing HDF5 file. <a href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">More...</a><br /></td></tr> +<tr class="separator:gaa3f4f877b9bb591f3880423ed2bf44bc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3f213eb05c5419d63ba168c30036e47b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga3f213eb05c5419d63ba168c30036e47b">H5Freopen</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id)</td></tr> +<tr class="memdesc:ga3f213eb05c5419d63ba168c30036e47b"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new identifier for a previously-opened HDF5 file. <a href="group___h5_f.html#ga3f213eb05c5419d63ba168c30036e47b">More...</a><br /></td></tr> +<tr class="separator:ga3f213eb05c5419d63ba168c30036e47b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae686870f0a276c4d06bbc667b2c24124"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gae686870f0a276c4d06bbc667b2c24124">H5Fflush</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> object_id, <a class="el" href="_h5_fpublic_8h.html#ac9db1b1211555797021daed9b54b8cdf">H5F_scope_t</a> scope)</td></tr> +<tr class="memdesc:gae686870f0a276c4d06bbc667b2c24124"><td class="mdescLeft"> </td><td class="mdescRight">Flushes all buffers associated with a file to storage. <a href="group___h5_f.html#gae686870f0a276c4d06bbc667b2c24124">More...</a><br /></td></tr> +<tr class="separator:gae686870f0a276c4d06bbc667b2c24124"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac55cd91d80822e4f8c2a7f04ea71b124"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id)</td></tr> +<tr class="memdesc:gac55cd91d80822e4f8c2a7f04ea71b124"><td class="mdescLeft"> </td><td class="mdescRight">Terminates access to an HDF5 file. <a href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">More...</a><br /></td></tr> +<tr class="separator:gac55cd91d80822e4f8c2a7f04ea71b124"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2e8b5e19b343123e8ab21442f9169a62"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62">H5Fdelete</a> (const char *filename, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id)</td></tr> +<tr class="memdesc:ga2e8b5e19b343123e8ab21442f9169a62"><td class="mdescLeft"> </td><td class="mdescRight">Deletes an HDF5 file. <a href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62">More...</a><br /></td></tr> +<tr class="separator:ga2e8b5e19b343123e8ab21442f9169a62"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2f823a9e929b00b06a6be80619a61778"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga2f823a9e929b00b06a6be80619a61778">H5Fget_create_plist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id)</td></tr> +<tr class="memdesc:ga2f823a9e929b00b06a6be80619a61778"><td class="mdescLeft"> </td><td class="mdescRight">Returns a file creation property list identifier. <a href="group___h5_f.html#ga2f823a9e929b00b06a6be80619a61778">More...</a><br /></td></tr> +<tr class="separator:ga2f823a9e929b00b06a6be80619a61778"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga359585c49f82f5199178777b39e780f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga359585c49f82f5199178777b39e780f4">H5Fget_access_plist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id)</td></tr> +<tr class="memdesc:ga359585c49f82f5199178777b39e780f4"><td class="mdescLeft"> </td><td class="mdescRight">Returns a file access property list identifier. <a href="group___h5_f.html#ga359585c49f82f5199178777b39e780f4">More...</a><br /></td></tr> +<tr class="separator:ga359585c49f82f5199178777b39e780f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga466179d7783d256329c2e3110055a16c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga466179d7783d256329c2e3110055a16c">H5Fget_intent</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, unsigned *intent)</td></tr> +<tr class="memdesc:ga466179d7783d256329c2e3110055a16c"><td class="mdescLeft"> </td><td class="mdescRight">Determines the read/write or read-only status of a file. <a href="group___h5_f.html#ga466179d7783d256329c2e3110055a16c">More...</a><br /></td></tr> +<tr class="separator:ga466179d7783d256329c2e3110055a16c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga402205688af065ab5db0fe20417d5484"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga402205688af065ab5db0fe20417d5484">H5Fget_fileno</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, unsigned long *fileno)</td></tr> +<tr class="memdesc:ga402205688af065ab5db0fe20417d5484"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a file's file number that uniquely identifies an open file. <a href="group___h5_f.html#ga402205688af065ab5db0fe20417d5484">More...</a><br /></td></tr> +<tr class="separator:ga402205688af065ab5db0fe20417d5484"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadcdae0aca7c88064db0d32de7f1e31f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gadcdae0aca7c88064db0d32de7f1e31f2">H5Fget_obj_count</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, unsigned types)</td></tr> +<tr class="memdesc:gadcdae0aca7c88064db0d32de7f1e31f2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of open object identifiers for an open file. <a href="group___h5_f.html#gadcdae0aca7c88064db0d32de7f1e31f2">More...</a><br /></td></tr> +<tr class="separator:gadcdae0aca7c88064db0d32de7f1e31f2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga35e72579bd07433162b80ddc0bd0c5b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga35e72579bd07433162b80ddc0bd0c5b1">H5Fget_obj_ids</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, unsigned types, size_t max_objs, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> *obj_id_list)</td></tr> +<tr class="memdesc:ga35e72579bd07433162b80ddc0bd0c5b1"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of open object identifiers. <a href="group___h5_f.html#ga35e72579bd07433162b80ddc0bd0c5b1">More...</a><br /></td></tr> +<tr class="separator:ga35e72579bd07433162b80ddc0bd0c5b1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae4020a66fb8da0586e3b74c81ffccea4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gae4020a66fb8da0586e3b74c81ffccea4">H5Fget_vfd_handle</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl, void **file_handle)</td></tr> +<tr class="memdesc:gae4020a66fb8da0586e3b74c81ffccea4"><td class="mdescLeft"> </td><td class="mdescRight">Returns pointer to the file handle from the virtual file driver. <a href="group___h5_f.html#gae4020a66fb8da0586e3b74c81ffccea4">More...</a><br /></td></tr> +<tr class="separator:gae4020a66fb8da0586e3b74c81ffccea4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7c4865fd36ee25d839725252150bb53b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga7c4865fd36ee25d839725252150bb53b">H5Fmount</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> child, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist)</td></tr> +<tr class="memdesc:ga7c4865fd36ee25d839725252150bb53b"><td class="mdescLeft"> </td><td class="mdescRight">Mounts an HDF5 file. <a href="group___h5_f.html#ga7c4865fd36ee25d839725252150bb53b">More...</a><br /></td></tr> +<tr class="separator:ga7c4865fd36ee25d839725252150bb53b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae8f807d3f04a33f132ffb6c5295e897f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gae8f807d3f04a33f132ffb6c5295e897f">H5Funmount</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc, const char *name)</td></tr> +<tr class="memdesc:gae8f807d3f04a33f132ffb6c5295e897f"><td class="mdescLeft"> </td><td class="mdescRight">Unounts an HDF5 file. <a href="group___h5_f.html#gae8f807d3f04a33f132ffb6c5295e897f">More...</a><br /></td></tr> +<tr class="separator:gae8f807d3f04a33f132ffb6c5295e897f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3ef2673183567543346668a8f1eca2e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga3ef2673183567543346668a8f1eca2e9">H5Fget_freespace</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id)</td></tr> +<tr class="memdesc:ga3ef2673183567543346668a8f1eca2e9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of free space in a file (in bytes) <a href="group___h5_f.html#ga3ef2673183567543346668a8f1eca2e9">More...</a><br /></td></tr> +<tr class="separator:ga3ef2673183567543346668a8f1eca2e9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga515426821321c261a825b4e4a3f576fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga515426821321c261a825b4e4a3f576fe">H5Fget_filesize</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *size)</td></tr> +<tr class="memdesc:ga515426821321c261a825b4e4a3f576fe"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of an HDF5 file (in bytes) <a href="group___h5_f.html#ga515426821321c261a825b4e4a3f576fe">More...</a><br /></td></tr> +<tr class="separator:ga515426821321c261a825b4e4a3f576fe"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4c18bddafc652203944d889a602bd53f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga4c18bddafc652203944d889a602bd53f">H5Fget_eoa</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a> *eoa)</td></tr> +<tr class="memdesc:ga4c18bddafc652203944d889a602bd53f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the file's end-of-allocation (EOA) <a href="group___h5_f.html#ga4c18bddafc652203944d889a602bd53f">More...</a><br /></td></tr> +<tr class="separator:ga4c18bddafc652203944d889a602bd53f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadbe82c1f6e16c21062fabd20b0ffccd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gadbe82c1f6e16c21062fabd20b0ffccd4">H5Fincrement_filesize</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> increment)</td></tr> +<tr class="memdesc:gadbe82c1f6e16c21062fabd20b0ffccd4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the file' EOA to the maximum of (EOA, EOF) + increment. <a href="group___h5_f.html#gadbe82c1f6e16c21062fabd20b0ffccd4">More...</a><br /></td></tr> +<tr class="separator:gadbe82c1f6e16c21062fabd20b0ffccd4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadc53f4e76b1199cb5d2a8cb7fbb114ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gadc53f4e76b1199cb5d2a8cb7fbb114ad">H5Fget_file_image</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, void *buf_ptr, size_t buf_len)</td></tr> +<tr class="memdesc:gadc53f4e76b1199cb5d2a8cb7fbb114ad"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a copy of the image of an existing, open file. <a href="group___h5_f.html#gadc53f4e76b1199cb5d2a8cb7fbb114ad">More...</a><br /></td></tr> +<tr class="separator:gadc53f4e76b1199cb5d2a8cb7fbb114ad"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0ed43dbe476a160b73f55127c7db797c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga0ed43dbe476a160b73f55127c7db797c">H5Fget_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, char *name, size_t size)</td></tr> +<tr class="memdesc:ga0ed43dbe476a160b73f55127c7db797c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves name of file to which object belongs. <a href="group___h5_f.html#ga0ed43dbe476a160b73f55127c7db797c">More...</a><br /></td></tr> +<tr class="separator:ga0ed43dbe476a160b73f55127c7db797c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaced8c09c1559636a9c3f33dff3f4520e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gaced8c09c1559636a9c3f33dff3f4520e">H5Fget_info2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="struct_h5_f__info2__t.html">H5F_info2_t</a> *file_info)</td></tr> +<tr class="memdesc:gaced8c09c1559636a9c3f33dff3f4520e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves global file information. <a href="group___h5_f.html#gaced8c09c1559636a9c3f33dff3f4520e">More...</a><br /></td></tr> +<tr class="separator:gaced8c09c1559636a9c3f33dff3f4520e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab9cbf1a45f9dcda34b43f985b7848434"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gab9cbf1a45f9dcda34b43f985b7848434">H5Fget_free_sections</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5">H5F_mem_t</a> type, size_t nsects, <a class="el" href="struct_h5_f__sect__info__t.html">H5F_sect_info_t</a> *sect_info)</td></tr> +<tr class="memdesc:gab9cbf1a45f9dcda34b43f985b7848434"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves free-space section information for a file. <a href="group___h5_f.html#gab9cbf1a45f9dcda34b43f985b7848434">More...</a><br /></td></tr> +<tr class="separator:gab9cbf1a45f9dcda34b43f985b7848434"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafcc153d8606829d4401e93305e5246d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gafcc153d8606829d4401e93305e5246d7">H5Fclear_elink_file_cache</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id)</td></tr> +<tr class="memdesc:gafcc153d8606829d4401e93305e5246d7"><td class="mdescLeft"> </td><td class="mdescRight">Clears the external link open file cache. <a href="group___h5_f.html#gafcc153d8606829d4401e93305e5246d7">More...</a><br /></td></tr> +<tr class="separator:gafcc153d8606829d4401e93305e5246d7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4b833c33fe2e141a26b6f2ad559d3610"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga4b833c33fe2e141a26b6f2ad559d3610">H5Fset_libver_bounds</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2">H5F_libver_t</a> low, <a class="el" href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2">H5F_libver_t</a> high)</td></tr> +<tr class="memdesc:ga4b833c33fe2e141a26b6f2ad559d3610"><td class="mdescLeft"> </td><td class="mdescRight">Enables the switch of version bounds setting for a file. <a href="group___h5_f.html#ga4b833c33fe2e141a26b6f2ad559d3610">More...</a><br /></td></tr> +<tr class="separator:ga4b833c33fe2e141a26b6f2ad559d3610"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7ef1c0aab9a7a9112a8d0a788ec8696c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga7ef1c0aab9a7a9112a8d0a788ec8696c">H5Freset_page_buffering_stats</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id)</td></tr> +<tr class="memdesc:ga7ef1c0aab9a7a9112a8d0a788ec8696c"><td class="mdescLeft"> </td><td class="mdescRight">Resets the page buffer statistics. <a href="group___h5_f.html#ga7ef1c0aab9a7a9112a8d0a788ec8696c">More...</a><br /></td></tr> +<tr class="separator:ga7ef1c0aab9a7a9112a8d0a788ec8696c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0663defe0143631f4292267c21e94202"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga0663defe0143631f4292267c21e94202">H5Fget_page_buffering_stats</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, unsigned accesses[2], unsigned hits[2], unsigned misses[2], unsigned evictions[2], unsigned bypasses[2])</td></tr> +<tr class="memdesc:ga0663defe0143631f4292267c21e94202"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves statistics about page access when it is enabled. <a href="group___h5_f.html#ga0663defe0143631f4292267c21e94202">More...</a><br /></td></tr> +<tr class="separator:ga0663defe0143631f4292267c21e94202"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacbf3ba8b36750c42b49740567a9732c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gacbf3ba8b36750c42b49740567a9732c4">H5Fget_dset_no_attrs_hint</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *minimize)</td></tr> +<tr class="memdesc:gacbf3ba8b36750c42b49740567a9732c4"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the setting for whether or not a file will create minimized dataset object headers. <a href="group___h5_f.html#gacbf3ba8b36750c42b49740567a9732c4">More...</a><br /></td></tr> +<tr class="separator:gacbf3ba8b36750c42b49740567a9732c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafc0166070f920f037e6b1a5c66e5464c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gafc0166070f920f037e6b1a5c66e5464c">H5Fset_dset_no_attrs_hint</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> minimize)</td></tr> +<tr class="memdesc:gafc0166070f920f037e6b1a5c66e5464c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the flag to create minimized dataset object headers. <a href="group___h5_f.html#gafc0166070f920f037e6b1a5c66e5464c">More...</a><br /></td></tr> +<tr class="separator:gafc0166070f920f037e6b1a5c66e5464c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga660153029322fa6b77f5473cedc2d72f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga660153029322fa6b77f5473cedc2d72f">H5Fget_info1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="struct_h5_f__info1__t.html">H5F_info1_t</a> *file_info)</td></tr> +<tr class="memdesc:ga660153029322fa6b77f5473cedc2d72f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves global file information. <a href="group___h5_f.html#ga660153029322fa6b77f5473cedc2d72f">More...</a><br /></td></tr> +<tr class="separator:ga660153029322fa6b77f5473cedc2d72f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae920c2acac63c0039db5c2845fb8e5bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#gae920c2acac63c0039db5c2845fb8e5bb">H5Fset_latest_format</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> latest_format)</td></tr> +<tr class="memdesc:gae920c2acac63c0039db5c2845fb8e5bb"><td class="mdescLeft"> </td><td class="mdescRight">Sets the latest version of the library to be used for writing objects. <a href="group___h5_f.html#gae920c2acac63c0039db5c2845fb8e5bb">More...</a><br /></td></tr> +<tr class="separator:gae920c2acac63c0039db5c2845fb8e5bb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6055c2ea3438bd4aaf221eba66843225"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_f.html#ga6055c2ea3438bd4aaf221eba66843225">H5Fis_hdf5</a> (const char *file_name)</td></tr> +<tr class="memdesc:ga6055c2ea3438bd4aaf221eba66843225"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a file is in the HDF5 format. <a href="group___h5_f.html#ga6055c2ea3438bd4aaf221eba66843225">More...</a><br /></td></tr> +<tr class="separator:ga6055c2ea3438bd4aaf221eba66843225"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a id="gae17036b3e36a8777328204e8bf073144"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae17036b3e36a8777328204e8bf073144">◆ </a></span>H5Fget_info</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5Fget_info   <a class="el" href="group___h5_f.html#gaced8c09c1559636a9c3f33dff3f4520e">H5Fget_info2</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p><a class="el" href="group___h5_f.html#gae17036b3e36a8777328204e8bf073144">H5Fget_info()</a> is a macro that is mapped to either <a class="el" href="group___h5_f.html#ga660153029322fa6b77f5473cedc2d72f" title="Retrieves global file information.">H5Fget_info1()</a> or <a class="el" href="group___h5_f.html#gaced8c09c1559636a9c3f33dff3f4520e" title="Retrieves global file information.">H5Fget_info2()</a>.<br /> +</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="gafcc153d8606829d4401e93305e5246d7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafcc153d8606829d4401e93305e5246d7">◆ </a></span>H5Fclear_elink_file_cache()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fclear_elink_file_cache </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Clears the external link open file cache. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#gafcc153d8606829d4401e93305e5246d7" title="Clears the external link open file cache.">H5Fclear_elink_file_cache()</a> 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> +<p><a class="el" href="group___h5_f.html#gafcc153d8606829d4401e93305e5246d7" title="Clears the external link open file cache.">H5Fclear_elink_file_cache()</a> does not close the cache itself; subsequent external link traversals from the parent file will again cache the target file. See <a class="el" href="group___f_a_p_l.html#gac21a815e9b133802df625c9f766ef325" title="Sets the number of files that can be held open in an external link open file cache.">H5Pset_elink_file_cache_size()</a> for information on closing the file cache.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___f_a_p_l.html#gac21a815e9b133802df625c9f766ef325" title="Sets the number of files that can be held open in an external link open file cache.">H5Pset_elink_file_cache_size()</a>, <a class="el" href="group___f_a_p_l.html#ga4c9bcfff90f48bfefa2c25e551485923" title="Retrieves the size of the external link open file cache.">H5Pget_elink_file_cache_size()</a></dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.8.7 </dd></dl> + +</div> +</div> +<a id="gac55cd91d80822e4f8c2a7f04ea71b124"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac55cd91d80822e4f8c2a7f04ea71b124">◆ </a></span>H5Fclose()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fclose </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Terminates access to an HDF5 file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> terminates access to an HDF5 file (specified by <code>file_id</code>) by flushing all data to storage.</p> +<p>If this is the last file identifier open for the file and no other access identifier is open (e.g., a dataset identifier, group identifier, or shared datatype identifier), the file will be fully closed and access will end.</p> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div> +<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a>;</div> +<div class="line"> <span class="keywordtype">char</span> name[] = <span class="stringliteral">"f11.h5"</span>;</div> +<div class="line"> </div> +<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file = <a class="code" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a>(name, mode, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div> +<div class="line"> <span class="keywordflow">if</span> (file != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>)</div> +<div class="line"> <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div> +<div class="line"> <span class="keywordflow">else</span></div> +<div class="line"> ret_val = EXIT_FAILURE;</div> +<div class="line"> }</div> +<div class="ttc" id="a_h5_fpublic_8h_html_a5a2d6726f9ad8d2bca8df2b817e5ad6a"><div class="ttname"><a href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a></div><div class="ttdeci">#define H5F_ACC_TRUNC</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:50</div></div> +</div><!-- fragment --> </dd></dl> +<dl class="section note"><dt>Note</dt><dd><b>Delayed close:</b> Note the following deviation from the above-described behavior. If <a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> is called for a file, but one or more objects within the file remain open, those objects will remain accessible until they are individually closed. Thus, if the dataset <code>data_sample</code> is open when <a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> is called for the file containing it, <code>data_sample</code> will remain open and accessible (including writable) until it is explicitly closed. The file will be automatically closed once all objects in the file have been closed.<br /> + Be warned, however, that there are circumstances where it is not possible to delay closing a file. For example, an MPI-IO file close is a collective call; all of the processes that open the file must close it collectively. The file cannot be closed at some time in the future by each process in an independent fashion. Another example is that an application using an AFS token-based file access privilege may destroy its AFS token after <a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> has returned successfully. This would make any future access to the file, or any object within it, illegal.<br /> + In such situations, applications must close all open objects in a file before calling H5Fclose. It is generally recommended to do so in all cases.</dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> </dd></dl> + +</div> +</div> +<a id="gae64b51ee9ac0781bc4ccc599d98387f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae64b51ee9ac0781bc4ccc599d98387f4">◆ </a></span>H5Fcreate()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Fcreate </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>filename</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>fcpl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>fapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates an HDF5 file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>Name of the file to create </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>File access flags. Allowable values are:<ul> +<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> +</ul> +</td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fcpl_id</td><td>File creation property list identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fapl_id</td><td>File access property list identifier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a file identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a> is the primary function for creating HDF5 files; it creates a new HDF5 file with the specified name and property lists.</p> +<p>The <code>filename</code> parameter specifies the name of the new file.</p> +<p>The <code>flags</code> parameter specifies whether an existing file is to be overwritten. It should be set to either <a class="el" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a> to overwrite an existing file or <a class="el" href="_h5_fpublic_8h.html#a7a47250dc1435705233dca7297ba3d90">H5F_ACC_EXCL</a>, instructing the function to fail if the file already exists.</p> +<p>New files are always created in read-write mode, so the read-write and read-only flags, <a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a> and <a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>, respectively, are not relevant in this function. Further note that a specification of <a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a> will be ignored; the file will be created in read-write mode, regardless.</p> +<p>More complex behaviors of file creation and access are controlled through the file creation and file access property lists, <code>fcpl_id</code> and <code>fapl_id</code>, respectively. The value of <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> for any property list value indicates that the library should use the default values for that appropriate property list.</p> +<p>The return value is a file identifier for the newly-created file; this file identifier should be closed by calling <a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> when it is no longer needed.</p> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div> +<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a>;</div> +<div class="line"> <span class="keywordtype">char</span> name[] = <span class="stringliteral">"f11.h5"</span>;</div> +<div class="line"> </div> +<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file = <a class="code" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a>(name, mode, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div> +<div class="line"> <span class="keywordflow">if</span> (file != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>)</div> +<div class="line"> <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div> +<div class="line"> <span class="keywordflow">else</span></div> +<div class="line"> ret_val = EXIT_FAILURE;</div> +<div class="line"> }</div> +</div><!-- fragment --> </dd></dl> +<dl class="section note"><dt>Note</dt><dd><a class="el" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a> and <a class="el" href="_h5_fpublic_8h.html#a7a47250dc1435705233dca7297ba3d90">H5F_ACC_EXCL</a> are mutually exclusive; use exactly one.</dd> +<dd> +An additional flag, <a class="el" href="_h5_fpublic_8h.html#af3ff563967a75b699c487fac04c42423">H5F_ACC_DEBUG</a>, prints debug information. This flag can be combined with one of the above values using the bit-wise OR operator (<code></code>|), but it is used only by HDF5 library developers; <em>it is neither tested nor supported for use in applications</em>.</dd></dl> +<dl class="section attention"><dt>Attention</dt><dd><b>Special case — File creation in the case of an already-open file:</b> If a file being created is already opened, by either a previous <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> or <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a> call, the HDF5 library may or may not detect that the open file and the new file are the same physical file. (See <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> regarding the limitations in detecting the re-opening of an already-open file.)<br /> + If the library detects that the file is already opened, <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a> will return a failure, regardless of the use of <a class="el" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a>.<br /> + If the library does not detect that the file is already opened and <a class="el" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a> is not used, <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a> will return a failure because the file already exists. Note that this is correct behavior.<br /> + But if the library does not detect that the file is already opened and <a class="el" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a> is used, <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a> will truncate the existing file and return a valid file identifier. Such a truncation of a currently-opened file will almost certainly result in errors. While unlikely, the HDF5 library may not be able to detect, and thus report, such errors.<br /> + Applications should avoid calling <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a> with an already opened file.</dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a>, <a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> </dd></dl> + +</div> +</div> +<a id="ga2e8b5e19b343123e8ab21442f9169a62"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2e8b5e19b343123e8ab21442f9169a62">◆ </a></span>H5Fdelete()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fdelete </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>filename</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>fapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Deletes an HDF5 file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>Name of the file to delete </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fapl_id</td><td>File access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62" title="Deletes an HDF5 file.">H5Fdelete()</a> deletes an HDF5 file <code>filename</code> with a file access property list <code>fapl_id</code>. The <code>fapl_id</code> should be configured with the same VOL connector or VFD that was used to open the file.</p> +<p>This API was introduced for use with the Virtual Object Layer (VOL). With the VOL, HDF5 "files" can map to arbitrary storage schemes such as object stores and relational database tables. The data created by these implementations may be inconvenient for a user to remove without a detailed knowledge of the storage scheme. <a class="el" href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62" title="Deletes an HDF5 file.">H5Fdelete()</a> gives VOL connector authors the ability to add connector-specific delete code to their connectors so that users can remove these "files" without detailed knowledge of the storage scheme.</p> +<p>For a VOL connector, <a class="el" href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62" title="Deletes an HDF5 file.">H5Fdelete()</a> deletes the file in a way that makes sense for the specified VOL connector.</p> +<p>For the native HDF5 connector, HDF5 files will be deleted via the VFDs, each of which will have to be modified to delete the files it creates.</p> +<p>For all implementations, <a class="el" href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62" title="Deletes an HDF5 file.">H5Fdelete()</a> will first check if the file is an HDF5 file via <a class="el" href="group___h5_f.html#ga584471c3b98453b9b04a4bf9af847442" title="Checks if a file can be opened with a given file access property list.">H5Fis_accessible()</a>. This is done to ensure that <a class="el" href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62" title="Deletes an HDF5 file.">H5Fdelete()</a> cannot be used as an arbitrary file deletion call.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="gae686870f0a276c4d06bbc667b2c24124"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae686870f0a276c4d06bbc667b2c24124">◆ </a></span>H5Fflush()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fflush </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>object_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_fpublic_8h.html#ac9db1b1211555797021daed9b54b8cdf">H5F_scope_t</a> </td> + <td class="paramname"><em>scope</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Flushes all buffers associated with a file to storage. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">object_id</td><td>Location identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">scope</td><td>The scope of the flush action</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#gae686870f0a276c4d06bbc667b2c24124" title="Flushes all buffers associated with a file to storage.">H5Fflush()</a> causes all buffers associated with a file to be immediately flushed to storage without removing the data from the cache.</p> +<p><code>object_id</code> can be any object associated with the file, including the file itself, a dataset, a group, an attribute, or a named datatype.</p> +<p><code>scope</code> specifies whether the scope of the flush action is global or local. Valid values are as follows: </p><table class="doxtable"> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#ac9db1b1211555797021daed9b54b8cdfa708b9b54ff5e7d75c9193f8ae864edaa">H5F_SCOPE_GLOBAL</a></td><td>Flushes the entire virtual file</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#ac9db1b1211555797021daed9b54b8cdfa3d09ee2d1551f31b008a7dc7d80b42bd">H5F_SCOPE_LOCAL</a></td><td>Flushes only the specified file</td></tr> +</table> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div> +<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>;</div> +<div class="line"> <span class="keywordtype">char</span> name[] = <span class="stringliteral">"f11.h5"</span>;</div> +<div class="line"> </div> +<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(name, mode, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div> +<div class="line"> <span class="keywordflow">if</span> (file != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"> <span class="keywordtype">int</span> step;</div> +<div class="line"> <span class="keywordflow">for</span> (step = 0; step < 1000; ++step) {</div> +<div class="line"> </div> +<div class="line"> <span class="comment">// do important work & flush every 20 steps</span></div> +<div class="line"> </div> +<div class="line"> <span class="keywordflow">if</span> (step % 20 == 0) {</div> +<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="group___h5_f.html#gae686870f0a276c4d06bbc667b2c24124">H5Fflush</a>(file, <a class="code" href="_h5_fpublic_8h.html#ac9db1b1211555797021daed9b54b8cdfa3d09ee2d1551f31b008a7dc7d80b42bd">H5F_SCOPE_LOCAL</a>) < 0) {</div> +<div class="line"> perror(<span class="stringliteral">"H5Fflush failed."</span>);</div> +<div class="line"> ret_val = EXIT_FAILURE;</div> +<div class="line"> <span class="keywordflow">break</span>;</div> +<div class="line"> }</div> +<div class="line"> }</div> +<div class="line"> }</div> +<div class="line"> </div> +<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file) < 0)</div> +<div class="line"> perror(<span class="stringliteral">"H5Fclose failed."</span>);</div> +<div class="line"> }</div> +<div class="line"> <span class="keywordflow">else</span></div> +<div class="line"> ret_val = EXIT_FAILURE;</div> +<div class="line"> }</div> +<div class="ttc" id="a_h5_fpublic_8h_html_ac9db1b1211555797021daed9b54b8cdfa3d09ee2d1551f31b008a7dc7d80b42bd"><div class="ttname"><a href="_h5_fpublic_8h.html#ac9db1b1211555797021daed9b54b8cdfa3d09ee2d1551f31b008a7dc7d80b42bd">H5F_SCOPE_LOCAL</a></div><div class="ttdeci">@ H5F_SCOPE_LOCAL</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:102</div></div> +<div class="ttc" id="agroup___h5_f_html_gae686870f0a276c4d06bbc667b2c24124"><div class="ttname"><a href="group___h5_f.html#gae686870f0a276c4d06bbc667b2c24124">H5Fflush</a></div><div class="ttdeci">herr_t H5Fflush(hid_t object_id, H5F_scope_t scope)</div><div class="ttdoc">Flushes all buffers associated with a file to storage.</div></div> +</div><!-- fragment --> </dd></dl> +<dl class="section attention"><dt>Attention</dt><dd>HDF5 does not possess full control over buffering. <a class="el" href="group___h5_f.html#gae686870f0a276c4d06bbc667b2c24124" title="Flushes all buffers associated with a file to storage.">H5Fflush()</a> flushes the internal HDF5 buffers and then asks the operating system (the OS) to flush the system buffers for the open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk. </dd></dl> + +</div> +</div> +<a id="ga359585c49f82f5199178777b39e780f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga359585c49f82f5199178777b39e780f4">◆ </a></span>H5Fget_access_plist()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Fget_access_plist </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns a file access property list identifier. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a file access property list identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga359585c49f82f5199178777b39e780f4" title="Returns a file access property list identifier.">H5Fget_access_plist()</a> returns the file access property list identifier of the specified file. </p> + +</div> +</div> +<a id="ga2f823a9e929b00b06a6be80619a61778"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2f823a9e929b00b06a6be80619a61778">◆ </a></span>H5Fget_create_plist()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Fget_create_plist </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns a file creation property list identifier. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a file creation property list identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga2f823a9e929b00b06a6be80619a61778" title="Returns a file creation property list identifier.">H5Fget_create_plist()</a> returns the file creation property list identifier identifying the creation properties used to create this file. This function is useful for duplicating properties when creating another file.</p> +<p>The creation property list identifier should be released with <a class="el" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb" title="Terminates access to a property list.">H5Pclose()</a>. </p> + +</div> +</div> +<a id="gacbf3ba8b36750c42b49740567a9732c4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gacbf3ba8b36750c42b49740567a9732c4">◆ </a></span>H5Fget_dset_no_attrs_hint()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_dset_no_attrs_hint </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> * </td> + <td class="paramname"><em>minimize</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the setting for whether or not a file will create minimized dataset object headers. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">minimize</td><td>Flag indicating whether the library will or will not create minimized dataset object headers</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#gacbf3ba8b36750c42b49740567a9732c4" title="Retrieves the setting for whether or not a file will create minimized dataset object headers.">H5Fget_dset_no_attrs_hint()</a> retrieves the no dataset attributes hint setting for the file specified by the file identifier <code>file_id</code>. This setting is used to inform the library to create minimized dataset object headers when <code>true</code>.</p> +<p>The setting's value is returned in the boolean pointer minimized.</p> +<dl class="section since"><dt>Since</dt><dd>1.10.5 </dd></dl> + +</div> +</div> +<a id="ga4c18bddafc652203944d889a602bd53f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4c18bddafc652203944d889a602bd53f">◆ </a></span>H5Fget_eoa()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_eoa </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a> * </td> + <td class="paramname"><em>eoa</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the file's end-of-allocation (EOA) </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">eoa</td><td>The file's EOA</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga4c18bddafc652203944d889a602bd53f" title="Retrieves the file's end-of-allocation (EOA)">H5Fget_eoa()</a> retrieves the file's EOA and returns it in the parameter eoa.</p> +<dl class="section since"><dt>Since</dt><dd>1.10.2 </dd></dl> + +</div> +</div> +<a id="gadc53f4e76b1199cb5d2a8cb7fbb114ad"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadc53f4e76b1199cb5d2a8cb7fbb114ad">◆ </a></span>H5Fget_file_image()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Fget_file_image </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>buf_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>buf_len</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves a copy of the image of an existing, open file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">buf_ptr</td><td>Pointer to the buffer into which the image of the HDF5 file is to be copied. If <code>buf_ptr</code> is NULL, no data will be copied but the function's return value will still indicate the buffer size required (or a negative value on error). </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">buf_len</td><td>Size of the supplied buffer</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>ssize_t</dd></dl> +<p><a class="el" href="group___h5_f.html#gadc53f4e76b1199cb5d2a8cb7fbb114ad" title="Retrieves a copy of the image of an existing, open file.">H5Fget_file_image()</a> retrieves a copy of the image of an existing, open file. This routine can be used with files opened using the SEC2 (or POSIX), STDIO, and Core (or Memory) virtual file drivers (VFDs).</p> +<p>If the return value of <a class="el" href="group___h5_f.html#gadc53f4e76b1199cb5d2a8cb7fbb114ad" title="Retrieves a copy of the image of an existing, open file.">H5Fget_file_image()</a> is a positive value, it will be the length in bytes of the buffer required to store the file image. So if the file size is unknown, it can be safely determined with an initial <a class="el" href="group___h5_f.html#gadc53f4e76b1199cb5d2a8cb7fbb114ad" title="Retrieves a copy of the image of an existing, open file.">H5Fget_file_image()</a> call with buf_ptr set to NULL. The file image can then be retrieved with a second <a class="el" href="group___h5_f.html#gadc53f4e76b1199cb5d2a8cb7fbb114ad" title="Retrieves a copy of the image of an existing, open file.">H5Fget_file_image()</a> call with <code>buf_len</code> set to the initial call's return value.</p> +<p>While the current file size can also be retrieved with <a class="el" href="group___h5_f.html#ga515426821321c261a825b4e4a3f576fe" title="Returns the size of an HDF5 file (in bytes)">H5Fget_filesize()</a>, that call may produce a larger value than is needed. The value returned by <a class="el" href="group___h5_f.html#ga515426821321c261a825b4e4a3f576fe" title="Returns the size of an HDF5 file (in bytes)">H5Fget_filesize()</a> includes the user block, if it exists, and any unallocated space at the end of the file. It is safe in all situations to get the file size with <a class="el" href="group___h5_f.html#gadc53f4e76b1199cb5d2a8cb7fbb114ad" title="Retrieves a copy of the image of an existing, open file.">H5Fget_file_image()</a> and it often produces a value that is more appropriate for the size of a file image buffer.</p> +<dl class="section note"><dt>Note</dt><dd><b>Recommended Reading:</b> This function is part of the file image operations feature set. It is highly recommended to study the guide <a href="https://portal.hdfgroup.org/display/HDF5/HDF5+File+Image+Operations">HDF5 File Image Operations</a> before using this feature set.</dd></dl> +<dl class="section attention"><dt>Attention</dt><dd><a class="el" href="group___f_a_p_l.html#ga337626cc516d5d1e3303ea6bc350e56b" title="Retrieves a copy of the file image designated as the initial content and structure of a file.">H5Pget_file_image()</a> will fail, returning a negative value, if the file is too large for the supplied buffer.</dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_l_t.html#ga07fcf2af194e87a3e45252544ebe4aa4" title="Opens an HDF5 file image in memory.">H5LTopen_file_image()</a>, <a class="el" href="group___f_a_p_l.html#ga31d0299f6ad287e013b2a02a8ccc1fa2" title="Sets an initial file image in a memory buffer.">H5Pset_file_image()</a>, <a class="el" href="group___f_a_p_l.html#ga337626cc516d5d1e3303ea6bc350e56b" title="Retrieves a copy of the file image designated as the initial content and structure of a file.">H5Pget_file_image()</a>, <a class="el" href="group___f_a_p_l.html#ga14ea3598215afd078b964b672b40d63c" title="Sets the callbacks for working with file images.">H5Pset_file_image_callbacks()</a>, <a class="el" href="group___f_a_p_l.html#gae17e38082dfdbadd75c897f1e6a9096e" title="Retrieves callback routines for working with file images.">H5Pget_file_image_callbacks()</a></dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="ga402205688af065ab5db0fe20417d5484"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga402205688af065ab5db0fe20417d5484">◆ </a></span>H5Fget_fileno()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_fileno </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned long * </td> + <td class="paramname"><em>fileno</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves a file's file number that uniquely identifies an open file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">fileno</td><td>A buffer to hold the file number</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga402205688af065ab5db0fe20417d5484" title="Retrieves a file's file number that uniquely identifies an open file.">H5Fget_fileno()</a> retrieves a file number for a file specified by the file identifier <code>file_id</code> and the pointer <code>fnumber</code> to the file number.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="ga515426821321c261a825b4e4a3f576fe"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga515426821321c261a825b4e4a3f576fe">◆ </a></span>H5Fget_filesize()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_filesize </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the size of an HDF5 file (in bytes) </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Size of the file, in bytes</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga515426821321c261a825b4e4a3f576fe" title="Returns the size of an HDF5 file (in bytes)">H5Fget_filesize()</a> returns the size of the HDF5 file specified by <code>file_id</code>.</p> +<p>The returned size is that of the entire file, as opposed to only the HDF5 portion of the file. I.e., size includes the user block, if any, the HDF5 portion of the file, and any data that may have been appended beyond the data written through the HDF5 library.</p> +<dl class="section since"><dt>Since</dt><dd>1.6.3 </dd></dl> + +</div> +</div> +<a id="gab9cbf1a45f9dcda34b43f985b7848434"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab9cbf1a45f9dcda34b43f985b7848434">◆ </a></span>H5Fget_free_sections()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Fget_free_sections </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5">H5F_mem_t</a> </td> + <td class="paramname"><em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>nsects</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_h5_f__sect__info__t.html">H5F_sect_info_t</a> * </td> + <td class="paramname"><em>sect_info</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves free-space section information for a file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The file memory allocation type </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">nsects</td><td>The number of free-space sections </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">sect_info</td><td>Array of instances of <a class="el" href="struct_h5_f__sect__info__t.html">H5F_sect_info_t</a> in which the free-space section information is to be returned</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the number of free-space sections for the specified free-space manager in the file; otherwise returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#gab9cbf1a45f9dcda34b43f985b7848434" title="Retrieves free-space section information for a file.">H5Fget_free_sections()</a> retrieves free-space section information for the free-space manager with type that is associated with file <code>file_id</code>. If type is <a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5a137331d00cf5b0c84ef7dfa725429f90">H5FD_MEM_DEFAULT</a>, this routine retrieves free-space section information for all the free-space managers in the file.</p> +<p>Valid values for <code>type</code> are the following: </p><table class="doxtable"> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5a137331d00cf5b0c84ef7dfa725429f90">H5FD_MEM_DEFAULT</a></td><td>The default file memory allocation type</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5ae536846ac8d6ecd1a2a8479409df1bce">H5FD_MEM_SUPER</a></td><td>File memory allocated for Superblock</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5a29b8528e16990fbe265682559b917fa3">H5FD_MEM_BTREE</a></td><td>File memory allocated for B-tree</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5ab435b061fede0393691acbe7cac2cb2e">H5FD_MEM_DRAW</a></td><td>File memory allocated for raw data</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5a020d6245f874e8262058c3278fefe58e">H5FD_MEM_GHEAP</a></td><td>File memory allocated for Global Heap</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5ae7536174d3ae2a842a71d6c192b43a13">H5FD_MEM_LHEAP</a></td><td>File memory allocated for Local Heap</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a51e588cd954ea2388816bd0818850eb5a4337f7056fb57717e82fa1081f496d75">H5FD_MEM_OHDR</a></td><td>File memory allocated for Object Header</td></tr> +</table> +<p><a class="el" href="struct_h5_f__sect__info__t.html">H5F_sect_info_t</a> is defined as follows (in <a class="el" href="_h5_fpublic_8h.html">H5Fpublic.h</a>): </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5_f__sect__info__t.html">H5F_sect_info_t</a> {</div> +<div class="line"> <a class="code" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a> <a class="code" href="struct_h5_f__sect__info__t.html#a0101c61f2ddf602478ae226012252a42">addr</a>; </div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_f__sect__info__t.html#aa5b212cd36c18ffdccd85c5363889d8b">size</a>; </div> +<div class="line">} <a class="code" href="struct_h5_f__sect__info__t.html">H5F_sect_info_t</a>;</div> +<div class="ttc" id="a_h5public_8h_html_a8c86e866f40d7167cf9a1934c72b856f"><div class="ttname"><a href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a></div><div class="ttdeci">uint64_t haddr_t</div><div class="ttdef"><b>Definition:</b> H5public.h:325</div></div> +<div class="ttc" id="astruct_h5_f__sect__info__t_html"><div class="ttname"><a href="struct_h5_f__sect__info__t.html">H5F_sect_info_t</a></div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:175</div></div> +<div class="ttc" id="astruct_h5_f__sect__info__t_html_a0101c61f2ddf602478ae226012252a42"><div class="ttname"><a href="struct_h5_f__sect__info__t.html#a0101c61f2ddf602478ae226012252a42">H5F_sect_info_t::addr</a></div><div class="ttdeci">haddr_t addr</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:176</div></div> +<div class="ttc" id="astruct_h5_f__sect__info__t_html_aa5b212cd36c18ffdccd85c5363889d8b"><div class="ttname"><a href="struct_h5_f__sect__info__t.html#aa5b212cd36c18ffdccd85c5363889d8b">H5F_sect_info_t::size</a></div><div class="ttdeci">hsize_t size</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:177</div></div> +</div><!-- fragment --><p> This routine retrieves free-space section information for <code>nsects</code> sections or, at most, the maximum number of sections in the specified free-space manager. If the number of sections is not known, a preliminary <a class="el" href="group___h5_f.html#gab9cbf1a45f9dcda34b43f985b7848434" title="Retrieves free-space section information for a file.">H5Fget_free_sections()</a> call can be made by setting <code>sect_info</code> to NULL and the total number of free-space sections for the specified free-space manager will be returned. Users can then allocate space for entries in <code>sect_info</code>, each of which is defined as an <a class="el" href="struct_h5_f__sect__info__t.html">H5F_sect_info_t</a> <code>struct</code>.</p> +<dl class="section attention"><dt>Attention</dt><dd><b>Failure Modes:</b> This routine will fail when the following is true: <ul> +<li>The library fails to retrieve the file creation property list associated with <code>file_id</code>. </li> +<li>If the parameter <code>sect_info</code> is non-null, but the parameter <code>nsects</code> is equal to 0. </li> +<li>The library fails to retrieve free-space section information for the file.</li> +</ul> +</dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl> + +</div> +</div> +<a id="ga3ef2673183567543346668a8f1eca2e9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3ef2673183567543346668a8f1eca2e9">◆ </a></span>H5Fget_freespace()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> H5Fget_freespace </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the amount of free space in a file (in bytes) </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the amount of free space in the file if successful; otherwise returns a negative value.</dd></dl> +<p>Given the identifier of an open file, <code>file_id</code>, <a class="el" href="group___h5_f.html#ga3ef2673183567543346668a8f1eca2e9" title="Returns the amount of free space in a file (in bytes)">H5Fget_freespace()</a> returns the amount of space that is unused by any objects in the file.</p> +<p>The interpretation of this number depends on the configured free space management strategy. For example, if the HDF5 library only tracks free space in a file from a file open or create until that file is closed, then this routine will report the free space that has been created during that interval.</p> +<dl class="section since"><dt>Since</dt><dd>1.6.1 </dd></dl> + +</div> +</div> +<a id="ga660153029322fa6b77f5473cedc2d72f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga660153029322fa6b77f5473cedc2d72f">◆ </a></span>H5Fget_info1()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_info1 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>obj_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_h5_f__info1__t.html">H5F_info1_t</a> * </td> + <td class="paramname"><em>file_info</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves global file information. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Object identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">file_info</td><td>Buffer for global file information</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000029">Deprecated:</a></b></dt><dd>This function has been renamed from <a class="el" href="group___h5_f.html#gae17036b3e36a8777328204e8bf073144">H5Fget_info()</a> and is deprecated in favor of the macro <a class="el" href="group___h5_f.html#gae17036b3e36a8777328204e8bf073144">H5Fget_info</a> or the function <a class="el" href="group___h5_f.html#gaced8c09c1559636a9c3f33dff3f4520e" title="Retrieves global file information.">H5Fget_info2()</a>.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga660153029322fa6b77f5473cedc2d72f" title="Retrieves global file information.">H5Fget_info1()</a> returns global information for the file associated with the object identifier <code>obj_id</code> in the <a class="el" href="struct_h5_f__info1__t.html">H5F_info1_t</a> <code>struct</code> named <code>file_info</code>.</p> +<p><code>obj_id</code> is an identifier for any object in the file of interest.</p> +<p><a class="el" href="struct_h5_f__info1__t.html">H5F_info1_t</a> struct is defined in <a class="el" href="_h5_fpublic_8h.html">H5Fpublic.h</a> as follows: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5_f__info1__t.html">H5F_info1_t</a> {</div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_f__info1__t.html#a4d6224a7603c148dfbbd66169698dcbf">super_ext_size</a>; </div> +<div class="line"> <span class="keyword">struct </span>{</div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_f__info1__t.html#a89b75e42126975a5e12777cf5915a8cb">hdr_size</a>; </div> +<div class="line"> <a class="code" href="struct_h5__ih__info__t.html">H5_ih_info_t</a> <a class="code" href="struct_h5_f__info1__t.html#a4bd7cc5a9377277d7ba270cb7173565b">msgs_info</a>; </div> +<div class="line"> } <a class="code" href="struct_h5_f__info1__t.html#a5cf928eff03dc598100ca7b4642ac263">sohm</a>;</div> +<div class="line">} <a class="code" href="struct_h5_f__info1__t.html">H5F_info1_t</a>;</div> +<div class="ttc" id="astruct_h5__ih__info__t_html"><div class="ttname"><a href="struct_h5__ih__info__t.html">H5_ih_info_t</a></div><div class="ttdef"><b>Definition:</b> H5public.h:379</div></div> +<div class="ttc" id="astruct_h5_f__info1__t_html"><div class="ttname"><a href="struct_h5_f__info1__t.html">H5F_info1_t</a></div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:1835</div></div> +<div class="ttc" id="astruct_h5_f__info1__t_html_a4bd7cc5a9377277d7ba270cb7173565b"><div class="ttname"><a href="struct_h5_f__info1__t.html#a4bd7cc5a9377277d7ba270cb7173565b">H5F_info1_t::msgs_info</a></div><div class="ttdeci">H5_ih_info_t msgs_info</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:1839</div></div> +<div class="ttc" id="astruct_h5_f__info1__t_html_a4d6224a7603c148dfbbd66169698dcbf"><div class="ttname"><a href="struct_h5_f__info1__t.html#a4d6224a7603c148dfbbd66169698dcbf">H5F_info1_t::super_ext_size</a></div><div class="ttdeci">hsize_t super_ext_size</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:1836</div></div> +<div class="ttc" id="astruct_h5_f__info1__t_html_a5cf928eff03dc598100ca7b4642ac263"><div class="ttname"><a href="struct_h5_f__info1__t.html#a5cf928eff03dc598100ca7b4642ac263">H5F_info1_t::sohm</a></div><div class="ttdeci">struct H5F_info1_t::@3 sohm</div></div> +<div class="ttc" id="astruct_h5_f__info1__t_html_a89b75e42126975a5e12777cf5915a8cb"><div class="ttname"><a href="struct_h5_f__info1__t.html#a89b75e42126975a5e12777cf5915a8cb">H5F_info1_t::hdr_size</a></div><div class="ttdeci">hsize_t hdr_size</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:1838</div></div> +</div><!-- fragment --><p> <code>super_ext_size</code> is the size of the superblock extension.</p> +<p>The <code>sohm</code> sub-struct contains shared object header message information as follows: </p><ul> +<li><code>hdr_size</code> is the size of the shared object header message. </li> +<li><code>msgs_info</code> is an <a class="el" href="struct_h5__ih__info__t.html">H5_ih_info_t</a> struct defined in <a class="el" href="_h5public_8h.html">H5public.h</a> as follows: <div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5__ih__info__t.html">H5_ih_info_t</a> {</div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5__ih__info__t.html#ab3841d02d93113f5443ea366617a1a81">index_size</a>; </div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5__ih__info__t.html#aa88bb4c49d4a0e04bfb6a0022e8ddb3a">heap_size</a>;</div> +<div class="line">} <a class="code" href="struct_h5__ih__info__t.html">H5_ih_info_t</a>;</div> +<div class="ttc" id="astruct_h5__ih__info__t_html_aa88bb4c49d4a0e04bfb6a0022e8ddb3a"><div class="ttname"><a href="struct_h5__ih__info__t.html#aa88bb4c49d4a0e04bfb6a0022e8ddb3a">H5_ih_info_t::heap_size</a></div><div class="ttdeci">hsize_t heap_size</div><div class="ttdef"><b>Definition:</b> H5public.h:381</div></div> +<div class="ttc" id="astruct_h5__ih__info__t_html_ab3841d02d93113f5443ea366617a1a81"><div class="ttname"><a href="struct_h5__ih__info__t.html#ab3841d02d93113f5443ea366617a1a81">H5_ih_info_t::index_size</a></div><div class="ttdeci">hsize_t index_size</div><div class="ttdef"><b>Definition:</b> H5public.h:380</div></div> +</div><!-- fragment --> </li> +<li><code>index_size</code> is the summed size of all the shared object header indexes. Each index might be either a B-tree or a list.</li> +</ul> +<dl class="section version"><dt>Version</dt><dd>1.10.0 Function <a class="el" href="group___h5_f.html#gae17036b3e36a8777328204e8bf073144">H5Fget_info()</a> renamed to <a class="el" href="group___h5_f.html#ga660153029322fa6b77f5473cedc2d72f" title="Retrieves global file information.">H5Fget_info1()</a> and deprecated in this release.</dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="gaced8c09c1559636a9c3f33dff3f4520e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaced8c09c1559636a9c3f33dff3f4520e">◆ </a></span>H5Fget_info2()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_info2 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>obj_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_h5_f__info2__t.html">H5F_info2_t</a> * </td> + <td class="paramname"><em>file_info</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves global file information. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Object identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">file_info</td><td>Buffer for global file information</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#gaced8c09c1559636a9c3f33dff3f4520e" title="Retrieves global file information.">H5Fget_info2()</a> returns global information for the file associated with the object identifier <code>obj_id</code> in the <a class="el" href="struct_h5_f__info2__t.html">H5F_info2_t</a> <code>struct</code> named <code>file_info</code>.</p> +<p><code>obj_id</code> is an identifier for any object in the file of interest.</p> +<p><a class="el" href="struct_h5_f__info2__t.html">H5F_info2_t</a> struct is defined in <a class="el" href="_h5_fpublic_8h.html">H5Fpublic.h</a> as follows: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5_f__info2__t.html">H5F_info2_t</a> {</div> +<div class="line"> <span class="keyword">struct </span>{</div> +<div class="line"> <span class="keywordtype">unsigned</span> <a class="code" href="struct_h5_f__info2__t.html#a27fe8e82cf2ce359010cc1d08af2e105">version</a>; </div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_f__info2__t.html#a42b47aca0b9262c0be11be63cbb0a4ce">super_size</a>; </div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_f__info2__t.html#a4d6224a7603c148dfbbd66169698dcbf">super_ext_size</a>; </div> +<div class="line"> } <a class="code" href="struct_h5_f__info2__t.html#aece286573a638f88e207dca20d4563ce">super</a>;</div> +<div class="line"> <span class="keyword">struct </span>{</div> +<div class="line"> <span class="keywordtype">unsigned</span> <a class="code" href="struct_h5_f__info2__t.html#a27fe8e82cf2ce359010cc1d08af2e105">version</a>; </div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_f__info2__t.html#adf422657c475d1354d312e2de99ba8d6">meta_size</a>; </div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_f__info2__t.html#acbee5790ff7f4679137389983cdb7440">tot_space</a>; </div> +<div class="line"> } <a class="code" href="struct_h5_f__info2__t.html#a98ac2f1e9d3425173c27a340ba26fac3">free</a>;</div> +<div class="line"> <span class="keyword">struct </span>{</div> +<div class="line"> <span class="keywordtype">unsigned</span> <a class="code" href="struct_h5_f__info2__t.html#a27fe8e82cf2ce359010cc1d08af2e105">version</a>; </div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_f__info2__t.html#a89b75e42126975a5e12777cf5915a8cb">hdr_size</a>; </div> +<div class="line"> <a class="code" href="struct_h5__ih__info__t.html">H5_ih_info_t</a> <a class="code" href="struct_h5_f__info2__t.html#a4bd7cc5a9377277d7ba270cb7173565b">msgs_info</a>; </div> +<div class="line"> } <a class="code" href="struct_h5_f__info2__t.html#a4aaa69a28fcfe66331d40c9ef7a49137">sohm</a>;</div> +<div class="line">} <a class="code" href="struct_h5_f__info2__t.html">H5F_info2_t</a>;</div> +<div class="ttc" id="astruct_h5_f__info2__t_html"><div class="ttname"><a href="struct_h5_f__info2__t.html">H5F_info2_t</a></div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:125</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_a27fe8e82cf2ce359010cc1d08af2e105"><div class="ttname"><a href="struct_h5_f__info2__t.html#a27fe8e82cf2ce359010cc1d08af2e105">H5F_info2_t::version</a></div><div class="ttdeci">unsigned version</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:127</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_a42b47aca0b9262c0be11be63cbb0a4ce"><div class="ttname"><a href="struct_h5_f__info2__t.html#a42b47aca0b9262c0be11be63cbb0a4ce">H5F_info2_t::super_size</a></div><div class="ttdeci">hsize_t super_size</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:128</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_a4aaa69a28fcfe66331d40c9ef7a49137"><div class="ttname"><a href="struct_h5_f__info2__t.html#a4aaa69a28fcfe66331d40c9ef7a49137">H5F_info2_t::sohm</a></div><div class="ttdeci">struct H5F_info2_t::@2 sohm</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_a4bd7cc5a9377277d7ba270cb7173565b"><div class="ttname"><a href="struct_h5_f__info2__t.html#a4bd7cc5a9377277d7ba270cb7173565b">H5F_info2_t::msgs_info</a></div><div class="ttdeci">H5_ih_info_t msgs_info</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:139</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_a4d6224a7603c148dfbbd66169698dcbf"><div class="ttname"><a href="struct_h5_f__info2__t.html#a4d6224a7603c148dfbbd66169698dcbf">H5F_info2_t::super_ext_size</a></div><div class="ttdeci">hsize_t super_ext_size</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:129</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_a89b75e42126975a5e12777cf5915a8cb"><div class="ttname"><a href="struct_h5_f__info2__t.html#a89b75e42126975a5e12777cf5915a8cb">H5F_info2_t::hdr_size</a></div><div class="ttdeci">hsize_t hdr_size</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:138</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_a98ac2f1e9d3425173c27a340ba26fac3"><div class="ttname"><a href="struct_h5_f__info2__t.html#a98ac2f1e9d3425173c27a340ba26fac3">H5F_info2_t::free</a></div><div class="ttdeci">struct H5F_info2_t::@1 free</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_acbee5790ff7f4679137389983cdb7440"><div class="ttname"><a href="struct_h5_f__info2__t.html#acbee5790ff7f4679137389983cdb7440">H5F_info2_t::tot_space</a></div><div class="ttdeci">hsize_t tot_space</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:134</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_adf422657c475d1354d312e2de99ba8d6"><div class="ttname"><a href="struct_h5_f__info2__t.html#adf422657c475d1354d312e2de99ba8d6">H5F_info2_t::meta_size</a></div><div class="ttdeci">hsize_t meta_size</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:133</div></div> +<div class="ttc" id="astruct_h5_f__info2__t_html_aece286573a638f88e207dca20d4563ce"><div class="ttname"><a href="struct_h5_f__info2__t.html#aece286573a638f88e207dca20d4563ce">H5F_info2_t::super</a></div><div class="ttdeci">struct H5F_info2_t::@0 super</div></div> +</div><!-- fragment --><p> The <code>super</code> sub-struct contains the following information: </p><ul> +<li><code>vers</code> is the version number of the superblock. </li> +<li><code>super_size</code> is the size of the superblock. </li> +<li><code>super_ext_size</code> is the size of the superblock extension.</li> +</ul> +<p>The <code>free</code> sub-struct contains the following information: </p><ul> +<li>vers is the version number of the free-space manager. </li> +<li><code>hdr_size</code> is the size of the free-space manager header. </li> +<li><code>tot_space</code> is the total amount of free space in the file.</li> +</ul> +<p>The <code>sohm</code> sub-struct contains shared object header message information as follows: </p><ul> +<li><code>vers</code> is the version number of the shared object header information. </li> +<li><code>hdr_size</code> is the size of the shared object header message. </li> +<li><code>msgs_info</code> is an <a class="el" href="struct_h5__ih__info__t.html">H5_ih_info_t</a> struct defined in <a class="el" href="_h5public_8h.html">H5public.h</a> as follows: <div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5__ih__info__t.html">H5_ih_info_t</a> {</div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5__ih__info__t.html#ab3841d02d93113f5443ea366617a1a81">index_size</a>; </div> +<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5__ih__info__t.html#aa88bb4c49d4a0e04bfb6a0022e8ddb3a">heap_size</a>;</div> +<div class="line">} <a class="code" href="struct_h5__ih__info__t.html">H5_ih_info_t</a>;</div> +</div><!-- fragment --> </li> +<li><code>index_size</code> is the summed size of all the shared object header indexes. Each index might be either a B-tree or a list. </li> +<li><code>heap_size</code> is the size of the heap.</li> +</ul> +<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl> + +</div> +</div> +<a id="ga466179d7783d256329c2e3110055a16c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga466179d7783d256329c2e3110055a16c">◆ </a></span>H5Fget_intent()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_intent </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned * </td> + <td class="paramname"><em>intent</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determines the read/write or read-only status of a file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">intent</td><td>Access mode flag as originally passed with <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>Given the identifier of an open file, <code>file_id</code>, <a class="el" href="group___h5_f.html#ga466179d7783d256329c2e3110055a16c" title="Determines the read/write or read-only status of a file.">H5Fget_intent()</a> retrieves the intended access mode" flag passed with <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> when the file was opened.</p> +<p>The value of the flag is returned in <code>intent</code>. Valid values are as follows: </p><table class="doxtable"> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a></td><td>File was opened with read/write access.</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a></td><td>File was opened with read-only access.</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a6217b039eabc4e484cee9813cbd0d020">H5F_ACC_SWMR_WRITE</a></td><td>File was opened with read/write access for a single-writer/multiple-reader (SWMR) scenario. Note that the writer process must also open the file with the <a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a> flag.</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a22b12837bca0dba6689096a370d73402">H5F_ACC_SWMR_READ</a></td><td>File was opened with read-only access for a single-writer/multiple-reader (SWMR) scenario. Note that the reader process must also open the file with the <a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a> flag.</td></tr> +</table> +<dl class="section note"><dt>Note</dt><dd>The function will not return an error if intent is NULL; it will simply do nothing.</dd></dl> +<dl class="section version"><dt>Version</dt><dd>1.10.0 Function enhanced to work with SWMR functionality.</dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="ga0ed43dbe476a160b73f55127c7db797c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0ed43dbe476a160b73f55127c7db797c">◆ </a></span>H5Fget_name()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Fget_name </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>obj_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves name of file to which object belongs. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Object identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Buffer for the file name </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size, in bytes, of the <code>name</code> buffer</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the length of the file name if successful; otherwise returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga0ed43dbe476a160b73f55127c7db797c" title="Retrieves name of file to which object belongs.">H5Fget_name()</a> retrieves the name of the file to which the object <code>obj_id</code> belongs. The object can be a file, group, dataset, attribute, or named datatype.</p> +<p>Up to <code>size</code> characters of the file name are returned in <code>name</code>; additional characters, if any, are not returned to the user application.</p> +<p>If the length of the name, which determines the required value of size, is unknown, a preliminary <a class="el" href="group___h5_f.html#ga0ed43dbe476a160b73f55127c7db797c" title="Retrieves name of file to which object belongs.">H5Fget_name()</a> call can be made by setting <code>name</code> to NULL. The return value of this call will be the size of the file name; that value plus one (1) can then be assigned to size for a second <a class="el" href="group___h5_f.html#ga0ed43dbe476a160b73f55127c7db797c" title="Retrieves name of file to which object belongs.">H5Fget_name()</a> call, which will retrieve the actual name. (The value passed in with the parameter <code>size</code> must be one greater than size in bytes of the actual name in order to accommodate the null terminator; if <code>size</code> is set to the exact size of the name, the last byte passed back will contain the null terminator and the last character will be missing from the name passed back to the calling application.)</p> +<p>If an error occurs, the buffer pointed to by <code>name</code> is unchanged and the function returns a negative value.</p> +<dl class="section since"><dt>Since</dt><dd>1.6.3 </dd></dl> + +</div> +</div> +<a id="gadcdae0aca7c88064db0d32de7f1e31f2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadcdae0aca7c88064db0d32de7f1e31f2">◆ </a></span>H5Fget_obj_count()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Fget_obj_count </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>types</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the number of open object identifiers for an open file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier or <a class="el" href="_h5_fpublic_8h.html#ad33eeeed36028dec422356d0e41a7113">H5F_OBJ_ALL</a> for all currently-open HDF5 files </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">types</td><td>Type of object for which identifiers are to be returned</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the number of open objects if successful; otherwise returns a negative value.</dd></dl> +<p>Given the identifier of an open file, file_id, and the desired object types, types, <a class="el" href="group___h5_f.html#gadcdae0aca7c88064db0d32de7f1e31f2" title="Returns the number of open object identifiers for an open file.">H5Fget_obj_count()</a> returns the number of open object identifiers for the file.</p> +<p>To retrieve a count of open identifiers for open objects in all HDF5 application files that are currently open, pass the value <a class="el" href="_h5_fpublic_8h.html#ad33eeeed36028dec422356d0e41a7113">H5F_OBJ_ALL</a> in <code>file_id</code>.</p> +<p>The types of objects to be counted are specified in types as follows: </p><table class="doxtable"> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a6e8e55fb44bd2be4c06f4094d42310d8">H5F_OBJ_FILE</a></td><td>Files only</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#afd59603f96ca7c23749b2a26befda4c5">H5F_OBJ_DATASET</a></td><td>Datasets only</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#ac8e6b9f94f3cf5e0d5376c90d6b6101b">H5F_OBJ_GROUP</a></td><td>Groups only</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#affd4ef14d9905d0d48f94719025dd72b">H5F_OBJ_DATATYPE</a></td><td>Named datatypes only</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#a7750c490f87481a65c709ba6b5b6b4a6">H5F_OBJ_ATTR</a></td><td>Attributes only</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#ad33eeeed36028dec422356d0e41a7113">H5F_OBJ_ALL</a></td><td>All of the above</td></tr> +<tr> +<td><a class="el" href="_h5_fpublic_8h.html#aaf4856a526e9a610d2688194f3ba4b57">H5F_OBJ_LOCAL</a></td><td>Restrict search to objects opened through current file identifier.</td></tr> +</table> +<dl class="section attention"><dt>Attention</dt><dd><a class="el" href="_h5_fpublic_8h.html#aaf4856a526e9a610d2688194f3ba4b57">H5F_OBJ_LOCAL</a> does not stand alone; it is effective only when used in combination with one or more of the preceding types. For example, <a class="el" href="_h5_fpublic_8h.html#afd59603f96ca7c23749b2a26befda4c5">H5F_OBJ_DATASET</a> | <a class="el" href="_h5_fpublic_8h.html#ac8e6b9f94f3cf5e0d5376c90d6b6101b">H5F_OBJ_GROUP</a> | <a class="el" href="_h5_fpublic_8h.html#aaf4856a526e9a610d2688194f3ba4b57">H5F_OBJ_LOCAL</a> would count all datasets and groups opened through the current file identifier.</dd></dl> +<p>Multiple object types can be combined with the logical <code>OR</code> operator (|). For example, the expression <code></code>(<a class="el" href="_h5_fpublic_8h.html#afd59603f96ca7c23749b2a26befda4c5">H5F_OBJ_DATASET</a>|<a class="el" href="_h5_fpublic_8h.html#ac8e6b9f94f3cf5e0d5376c90d6b6101b">H5F_OBJ_GROUP</a>) would call for datasets and groups.</p> +<dl class="section version"><dt>Version</dt><dd>1.6.8, 1.8.2 Function return type changed to <code>ssize_t</code>. </dd> +<dd> +1.6.5 <a class="el" href="_h5_fpublic_8h.html#aaf4856a526e9a610d2688194f3ba4b57">H5F_OBJ_LOCAL</a> has been added as a qualifier on the types of objects to be counted. <a class="el" href="_h5_fpublic_8h.html#aaf4856a526e9a610d2688194f3ba4b57">H5F_OBJ_LOCAL</a> restricts the search to objects opened through current file identifier. </dd></dl> + +</div> +</div> +<a id="ga35e72579bd07433162b80ddc0bd0c5b1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga35e72579bd07433162b80ddc0bd0c5b1">◆ </a></span>H5Fget_obj_ids()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Fget_obj_ids </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>types</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>max_objs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> * </td> + <td class="paramname"><em>obj_id_list</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns a list of open object identifiers. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier or <a class="el" href="_h5_fpublic_8h.html#ad33eeeed36028dec422356d0e41a7113">H5F_OBJ_ALL</a> for all currently-open HDF5 files </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">types</td><td>Type of object for which identifiers are to be returned </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">max_objs</td><td>Maximum number of object identifiers to place into <code>obj_id_list</code> </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">obj_id_list</td><td>Pointer to the returned buffer of open object identifiers</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns number of objects placed into <code>obj_id_list</code> if successful; otherwise returns a negative value.</dd></dl> +<p>Given the file identifier <code>file_id</code> and the type of objects to be identified, types, <a class="el" href="group___h5_f.html#ga35e72579bd07433162b80ddc0bd0c5b1" title="Returns a list of open object identifiers.">H5Fget_obj_ids()</a> returns the list of identifiers for all open HDF5 objects fitting the specified criteria.</p> +<p>To retrieve identifiers for open objects in all HDF5 application files that are currently open, pass the value <a class="el" href="_h5_fpublic_8h.html#ad33eeeed36028dec422356d0e41a7113">H5F_OBJ_ALL</a> in <code>file_id</code>.</p> +<p>The types of object identifiers to be retrieved are specified in types using the codes listed for the same parameter in <a class="el" href="group___h5_f.html#gadcdae0aca7c88064db0d32de7f1e31f2" title="Returns the number of open object identifiers for an open file.">H5Fget_obj_count()</a>.</p> +<p>To retrieve a count of open objects, use the <a class="el" href="group___h5_f.html#gadcdae0aca7c88064db0d32de7f1e31f2" title="Returns the number of open object identifiers for an open file.">H5Fget_obj_count()</a> function. This count can be used to set the <code>max_objs</code> parameter.</p> +<dl class="section version"><dt>Version</dt><dd>1.8.2 Function return type changed to <code>ssize_t</code> and <code>max_objs</code> parameter datatype changed to <code>size_t</code>. </dd> +<dd> +1.6.8 Function return type changed to <code>ssize_t</code> and <code>max_objs</code> parameter datatype changed to <code>size_t</code>. </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl> + +</div> +</div> +<a id="ga0663defe0143631f4292267c21e94202"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0663defe0143631f4292267c21e94202">◆ </a></span>H5Fget_page_buffering_stats()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_page_buffering_stats </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>accesses</em>[2], </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>hits</em>[2], </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>misses</em>[2], </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>evictions</em>[2], </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>bypasses</em>[2] </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves statistics about page access when it is enabled. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">accesses</td><td>Two integer array for the number of metadata and raw data accesses to the page buffer </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">hits</td><td>Two integer array for the number of metadata and raw data hits in the page buffer </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">misses</td><td>Two integer array for the number of metadata and raw data misses in the page buffer </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">evictions</td><td>Two integer array for the number of metadata and raw data evictions from the page buffer </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">bypasses</td><td>Two integer array for the number of metadata and raw data accesses that bypass the page buffer</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga0663defe0143631f4292267c21e94202" title="Retrieves statistics about page access when it is enabled.">H5Fget_page_buffering_stats()</a> retrieves page buffering statistics such as the number of metadata and raw data accesses (<code>accesses</code>), hits (<code>hits</code>), misses (<code>misses</code>), evictions (<code>evictions</code>), and accesses that bypass the page buffer (<code>bypasses</code>).</p> +<dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl> + +</div> +</div> +<a id="gae4020a66fb8da0586e3b74c81ffccea4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae4020a66fb8da0586e3b74c81ffccea4">◆ </a></span>H5Fget_vfd_handle()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_vfd_handle </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>fapl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void ** </td> + <td class="paramname"><em>file_handle</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns pointer to the file handle from the virtual file driver. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fapl</td><td>File access property list identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">file_handle</td><td>Pointer to the file handle being used by the low-level virtual file driver</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>Given the file identifier <code>file_id</code> and the file access property list <code>fapl_id</code>, <a class="el" href="group___h5_f.html#gae4020a66fb8da0586e3b74c81ffccea4" title="Returns pointer to the file handle from the virtual file driver.">H5Fget_vfd_handle()</a> returns a pointer to the file handle from the low-level file driver currently being used by the HDF5 library for file I/O.</p> +<dl class="section note"><dt>Note</dt><dd>For most drivers, the value of <code>fapl_id</code> will be <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>. For the <code>FAMILY</code> or <code>MULTI</code> drivers, this value should be defined through the property list functions: <a class="el" href="group___f_a_p_l.html#ga6b24e6daf4816bbfb89b63bab40aa982" title="Sets offset property for low-level access to a file in a family of files.">H5Pset_family_offset()</a> for the <code>FAMILY</code> driver and <a class="el" href="group___f_a_p_l.html#ga507341f31848c57008a3225bff3fe128" title="Specifies type of data to be accessed via the MULTI driver, enabling more direct access.">H5Pset_multi_type()</a> for the <code>MULTI</code> driver</dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl> + +</div> +</div> +<a id="gadbe82c1f6e16c21062fabd20b0ffccd4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadbe82c1f6e16c21062fabd20b0ffccd4">◆ </a></span>H5Fincrement_filesize()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fincrement_filesize </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td> + <td class="paramname"><em>increment</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets the file' EOA to the maximum of (EOA, EOF) + increment. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">increment</td><td>The number of bytes to be added to the maximum of (EOA, EOF)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#gadbe82c1f6e16c21062fabd20b0ffccd4" title="Sets the file' EOA to the maximum of (EOA, EOF) + increment.">H5Fincrement_filesize()</a> sets the file's EOA to the maximum of (EOA, EOF) + <code>increment</code>. The EOA is the end-of-file address stored in the file's superblock while EOF is the file's actual end-of-file.</p> +<dl class="section since"><dt>Since</dt><dd>1.10.2 </dd></dl> + +</div> +</div> +<a id="ga584471c3b98453b9b04a4bf9af847442"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga584471c3b98453b9b04a4bf9af847442">◆ </a></span>H5Fis_accessible()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Fis_accessible </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>container_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>fapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Checks if a file can be opened with a given file access property list. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">container_name</td><td>Name of a file </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fapl_id</td><td>File access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga584471c3b98453b9b04a4bf9af847442" title="Checks if a file can be opened with a given file access property list.">H5Fis_accessible()</a> checks if the file specified by <code>container_name</code> can be opened with the file access property list <code>fapl_id</code>.</p> +<dl class="section note"><dt>Note</dt><dd>The <a class="el" href="group___h5_f.html#ga584471c3b98453b9b04a4bf9af847442" title="Checks if a file can be opened with a given file access property list.">H5Fis_accessible()</a> function enables files to be checked with a given file access property list, unlike <a class="el" href="group___h5_f.html#ga6055c2ea3438bd4aaf221eba66843225" title="Determines whether a file is in the HDF5 format.">H5Fis_hdf5()</a>, which only uses the default file driver when opening a file.</dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="ga6055c2ea3438bd4aaf221eba66843225"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga6055c2ea3438bd4aaf221eba66843225">◆ </a></span>H5Fis_hdf5()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Fis_hdf5 </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>file_name</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determines whether a file is in the HDF5 format. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_name</td><td>File name</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000031">Deprecated:</a></b></dt><dd>When?</dd></dl> +<p><a class="el" href="group___h5_f.html#ga6055c2ea3438bd4aaf221eba66843225" title="Determines whether a file is in the HDF5 format.">H5Fis_hdf5()</a> determines whether a file is in the HDF5 format.</p> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000019">Todo:</a></b></dt><dd><p class="startdd">In which version was this function deprecated? </p> +<p class="enddd">In which version was this function introduced?</p> +</dd></dl> + +</div> +</div> +<a id="ga7c4865fd36ee25d839725252150bb53b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7c4865fd36ee25d839725252150bb53b">◆ </a></span>H5Fmount()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fmount </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>loc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>child</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>plist</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Mounts an HDF5 file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">loc</td><td>Location identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the group onto which the file specified by <code>child</code> is to be mounted </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">child</td><td>File identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">plist</td><td>File mount property list identifier. Pass <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>!</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga7c4865fd36ee25d839725252150bb53b" title="Mounts an HDF5 file.">H5Fmount()</a> mounts the file specified by <code>child</code> onto the object specified by <code>loc</code> and <code>name</code> using the mount properties <code>plist</code> If the object specified by <code>loc</code> is a dataset, named datatype or attribute, then the file will be mounted at the location where the attribute, dataset, or named datatype is attached.</p> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div> +<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(<span class="stringliteral">"f11.h5"</span>, <a class="code" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div> +<div class="line"> <span class="keywordflow">if</span> (file != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> group, child;</div> +<div class="line"> <span class="keywordflow">if</span> ((group = <a class="code" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980">H5Gcreate1</a>(file, <span class="stringliteral">"mount_point"</span>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"> <span class="keywordflow">if</span> ((child = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(<span class="stringliteral">"f1.h5"</span>, <a class="code" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="group___h5_f.html#ga7c4865fd36ee25d839725252150bb53b">H5Fmount</a>(group, <span class="stringliteral">"."</span>, child, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) >= 0) {</div> +<div class="line"> </div> +<div class="line"> <span class="comment">// do something useful w/ the mounted file</span></div> +<div class="line"> }</div> +<div class="line"> <span class="keywordflow">else</span> {</div> +<div class="line"> ret_val = EXIT_FAILURE;</div> +<div class="line"> perror(<span class="stringliteral">"H5Fmount failed."</span>);</div> +<div class="line"> }</div> +<div class="line"> <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(child);</div> +<div class="line"> }</div> +<div class="line"> <a class="code" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">H5Gclose</a>(group);</div> +<div class="line"> }</div> +<div class="line"> <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div> +<div class="line"> }</div> +<div class="line"> <span class="keywordflow">else</span></div> +<div class="line"> ret_val = EXIT_FAILURE;</div> +<div class="line"> }</div> +<div class="ttc" id="agroup___h5_f_html_ga7c4865fd36ee25d839725252150bb53b"><div class="ttname"><a href="group___h5_f.html#ga7c4865fd36ee25d839725252150bb53b">H5Fmount</a></div><div class="ttdeci">herr_t H5Fmount(hid_t loc, const char *name, hid_t child, hid_t plist)</div><div class="ttdoc">Mounts an HDF5 file.</div></div> +<div class="ttc" id="agroup___h5_g_html_ga7397440085510728a2e2d22199e81980"><div class="ttname"><a href="group___h5_g.html#ga7397440085510728a2e2d22199e81980">H5Gcreate1</a></div><div class="ttdeci">hid_t H5Gcreate1(hid_t loc_id, const char *name, size_t size_hint)</div><div class="ttdoc">Creates a new group and links it into the file.</div></div> +<div class="ttc" id="agroup___h5_g_html_ga8dbe20b390d2504f0bd3589ed8f4e221"><div class="ttname"><a href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">H5Gclose</a></div><div class="ttdeci">herr_t H5Gclose(hid_t group_id)</div><div class="ttdoc">Closes the specified group.</div></div> +</div><!-- fragment --> </dd></dl> +<dl class="section note"><dt>Note</dt><dd>To date, no file mount properties have been defined in HDF5. The proper value to pass for <code>plist</code> is <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, indicating the default file mount property list. </dd></dl> + +</div> +</div> +<a id="gaa3f4f877b9bb591f3880423ed2bf44bc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa3f4f877b9bb591f3880423ed2bf44bc">◆ </a></span>H5Fopen()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Fopen </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>filename</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>fapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Opens an existing HDF5 file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>Name of the file to be opened </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>File access flags. Allowable values are:<ul> +<li><a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>: Allows read and write access to file</li> +<li><a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>: Allows read-only access to file</li> +<li><a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a> <code></code>| <a class="el" href="_h5_fpublic_8h.html#a6217b039eabc4e484cee9813cbd0d020">H5F_ACC_SWMR_WRITE</a>: Indicates that the file is open for writing in a single-writer/multi-writer (SWMR) scenario.</li> +<li><a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a> <code></code>| <a class="el" href="_h5_fpublic_8h.html#a22b12837bca0dba6689096a370d73402">H5F_ACC_SWMR_READ</a>: Indicates that the file is open for reading in a single-writer/multi-reader (SWMR) scenario.</li> +<li>An additional flag, <a class="el" href="_h5_fpublic_8h.html#af3ff563967a75b699c487fac04c42423">H5F_ACC_DEBUG</a>, prints debug information. This flag can be combined with one of the above values using the bit-wise OR operator (<code></code>|), but it is used only by HDF5 library developers; <em>it is neither tested nor supported</em> for use in applications. </li> +</ul> +</td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fapl_id</td><td>File access property list identifier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a file identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> is the primary function for accessing existing HDF5 files. This function opens the named file in the specified access mode and with the specified access property list.</p> +<p>Note that <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> does not create a file if it does not already exist; see <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a>.</p> +<p>The <code>filename</code> parameter specifies the name of the file to be opened.</p> +<p>The <code>fapl_id</code> parameter specifies the file access property list. The use of <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> specifies that default I/O access properties are to be used.</p> +<p>The <code>flags</code> parameter specifies whether the file will be opened in read-write or read-only mode, <a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a> or <a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>, respectively. More complex behaviors of file access are controlled through the file-access property list.</p> +<p>The return value is a file identifier for the open file; this file identifier should be closed by calling <a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> when it is no longer needed.</p> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div> +<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>;</div> +<div class="line"> <span class="keywordtype">char</span> name[] = <span class="stringliteral">"f11.h5"</span>;</div> +<div class="line"> </div> +<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(name, mode, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div> +<div class="line"> <span class="keywordflow">if</span> (file != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>)</div> +<div class="line"> <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div> +<div class="line"> <span class="keywordflow">else</span></div> +<div class="line"> ret_val = EXIT_FAILURE;</div> +<div class="line"> }</div> +</div><!-- fragment --> </dd></dl> +<dl class="section note"><dt>Note</dt><dd><a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a> and <a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a> are mutually exclusive; use exactly one.</dd></dl> +<dl class="section attention"><dt>Attention</dt><dd><b>Special cases — Multiple opens:</b> A file can often be opened with a new <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> call without closing an already-open identifier established in a previous <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> or <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a> call. Each such <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> call will return a unique identifier and the file can be accessed through any of these identifiers as long as the identifier remains valid. In such multiply-opened cases, the open calls must use the same flags argument and the file access property lists must use the same file close degree property setting (see the external link discussion below and <a class="el" href="group___f_a_p_l.html#ga60e3567f677fd3ade75b909b636d7b9c" title="Sets the file close degree.">H5Pset_fclose_degree()</a>).<br /> + In some cases, such as files on a local Unix file system, the HDF5 library can detect that a file is multiply opened and will maintain coherent access among the file identifiers.<br /> + But in many other cases, such as parallel file systems or networked file systems, it is not always possible to detect multiple opens of the same physical file. In such cases, HDF5 will treat the file identifiers as though they are accessing different files and will be unable to maintain coherent access. Errors are likely to result in these cases. While unlikely, the HDF5 library may not be able to detect, and thus report, such errors.<br /> + It is generally recommended that applications avoid multiple opens of the same file.</dd> +<dd> +<b>Special restriction on multiple opens of a file first opened by means of an external link:</b> When an external link is followed, the external file is always opened with the weak file close degree property setting, <a class="el" href="_h5_fpublic_8h.html#aa85fa00d037d2b0401cf72edf9a6475faea1127311a219b44e4af3cb12609035f">H5F_CLOSE_WEAK</a> (see <a class="el" href="group___h5_l.html#ga15dfaeb9b1c0b3136533cb97ee45e683" title="Creates an external link, a soft link to an object in a different file.">H5Lcreate_external()</a> and <a class="el" href="group___f_a_p_l.html#ga60e3567f677fd3ade75b909b636d7b9c" title="Sets the file close degree.">H5Pset_fclose_degree()</a>). If the file is reopened with H5Fopen while it remains held open from such an external link call, the file access property list used in the open call must include the file close degree setting <a class="el" href="_h5_fpublic_8h.html#aa85fa00d037d2b0401cf72edf9a6475faea1127311a219b44e4af3cb12609035f">H5F_CLOSE_WEAK</a> or the open will fail.</dd></dl> +<dl class="section version"><dt>Version</dt><dd>1.10.0 The <a class="el" href="_h5_fpublic_8h.html#a6217b039eabc4e484cee9813cbd0d020">H5F_ACC_SWMR_WRITE</a> and <a class="el" href="_h5_fpublic_8h.html#a22b12837bca0dba6689096a370d73402">H5F_ACC_SWMR_READ</a> flags were added.</dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> </dd></dl> + +</div> +</div> +<a id="ga3f213eb05c5419d63ba168c30036e47b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3f213eb05c5419d63ba168c30036e47b">◆ </a></span>H5Freopen()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Freopen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns a new identifier for a previously-opened HDF5 file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>Identifier of a file for which an additional identifier is required</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a file identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga3f213eb05c5419d63ba168c30036e47b" title="Returns a new identifier for a previously-opened HDF5 file.">H5Freopen()</a> returns a new file identifier for an already-open HDF5 file, as specified by <code>file_id</code>. Both identifiers share caches and other information. The only difference between the identifiers is that the new identifier is not mounted anywhere and no files are mounted on it.</p> +<p>The new file identifier should be closed by calling <a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> when it is no longer needed.</p> +<dl class="section note"><dt>Note</dt><dd>Note that there is no circumstance under which <a class="el" href="group___h5_f.html#ga3f213eb05c5419d63ba168c30036e47b" title="Returns a new identifier for a previously-opened HDF5 file.">H5Freopen()</a> can actually open a closed file; the file must already be open and have an active <code>file_id</code>. E.g., one cannot close a file with <a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a> on <code>file_id</code> then use <a class="el" href="group___h5_f.html#ga3f213eb05c5419d63ba168c30036e47b" title="Returns a new identifier for a previously-opened HDF5 file.">H5Freopen()</a> on <code>file_id</code> to reopen it. </dd></dl> + +</div> +</div> +<a id="ga7ef1c0aab9a7a9112a8d0a788ec8696c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7ef1c0aab9a7a9112a8d0a788ec8696c">◆ </a></span>H5Freset_page_buffering_stats()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Freset_page_buffering_stats </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Resets the page buffer statistics. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga7ef1c0aab9a7a9112a8d0a788ec8696c" title="Resets the page buffer statistics.">H5Freset_page_buffering_stats()</a> resets the page buffer statistics for a specified file identifier <code>file_id</code>.</p> +<dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl> + +</div> +</div> +<a id="gafc0166070f920f037e6b1a5c66e5464c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafc0166070f920f037e6b1a5c66e5464c">◆ </a></span>H5Fset_dset_no_attrs_hint()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fset_dset_no_attrs_hint </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> </td> + <td class="paramname"><em>minimize</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets the flag to create minimized dataset object headers. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">minimize</td><td>Flag indicating whether the library will or will not create minimized dataset object headers</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#gafc0166070f920f037e6b1a5c66e5464c" title="Sets the flag to create minimized dataset object headers.">H5Fset_dset_no_attrs_hint()</a> sets the no dataset attributes hint setting for the file specified by the file identifier <code>file_id</code>. If the boolean flag <code>minimize</code> is set to <code>true</code>, then the library will create minimized dataset object headers in the file. <b>All</b> files that refer to the same file-on-disk will be affected by the most recent setting, regardless of the file identifier/handle (e.g., as returned by <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a>). By setting the <code>minimize</code> flag to <code>true</code>, the library expects that no attributes will be added to the dataset - attributes can be added, but they are appended with a continuation message, which can reduce performance.</p> +<dl class="section attention"><dt>Attention</dt><dd>This setting interacts with <a class="el" href="group___d_c_p_l.html#gaf5ae8c0257c02e3fbe50bde70b1eb8be" title="Sets the flag to create minimized dataset object headers.">H5Pset_dset_no_attrs_hint()</a>: if either is set to <code>true</code>, then the created dataset's object header will be minimized.</dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.10.5 </dd></dl> + +</div> +</div> +<a id="gae920c2acac63c0039db5c2845fb8e5bb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae920c2acac63c0039db5c2845fb8e5bb">◆ </a></span>H5Fset_latest_format()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fset_latest_format </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> </td> + <td class="paramname"><em>latest_format</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets the latest version of the library to be used for writing objects. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">latest_format</td><td>Latest format flag</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000030">Deprecated:</a></b></dt><dd>When?</dd></dl> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000018">Todo:</a></b></dt><dd><p class="startdd">In which version was this function introduced? </p> +<p class="enddd">In which version was this function deprecated?</p> +</dd></dl> + +</div> +</div> +<a id="ga4b833c33fe2e141a26b6f2ad559d3610"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4b833c33fe2e141a26b6f2ad559d3610">◆ </a></span>H5Fset_libver_bounds()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fset_libver_bounds </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>file_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2">H5F_libver_t</a> </td> + <td class="paramname"><em>low</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2">H5F_libver_t</a> </td> + <td class="paramname"><em>high</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Enables the switch of version bounds setting for a file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">file_id</td><td>File identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">low</td><td>The earliest version of the library that will be used for writing objects </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">high</td><td>The latest version of the library that will be used for writing objects</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p><a class="el" href="group___h5_f.html#ga4b833c33fe2e141a26b6f2ad559d3610" title="Enables the switch of version bounds setting for a file.">H5Fset_libver_bounds()</a> enables the switch of version bounds setting for an open file associated with <code>file_id</code>.</p> +<p>For the parameters <code>low</code> and <code>high</code>, see the description for <a class="el" href="group___f_a_p_l.html#gacbe1724e7f70cd17ed687417a1d2a910" title="Controls the range of library release versions used when creating objects in a file.">H5Pset_libver_bounds()</a>.</p> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div> +<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>;</div> +<div class="line"> <span class="keywordtype">char</span> name[] = <span class="stringliteral">"f11.h5"</span>;</div> +<div class="line"> </div> +<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(name, mode, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div> +<div class="line"> <span class="keywordflow">if</span> (file != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div> +<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="group___h5_f.html#ga4b833c33fe2e141a26b6f2ad559d3610">H5Fset_libver_bounds</a>(file, <a class="code" href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2abed98059b4a02d048b1eb3985fba5fa1">H5F_LIBVER_EARLIEST</a>, <a class="code" href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2a434ca8def77a117013577c8cec6af0d8">H5F_LIBVER_V18</a>) >= 0) {</div> +<div class="line"> </div> +<div class="line"> <span class="comment">// object creation will not exceed HDF5 version 1.8.x</span></div> +<div class="line"> }</div> +<div class="line"> <span class="keywordflow">else</span></div> +<div class="line"> perror(<span class="stringliteral">"H5Fset_libver_bounds failed."</span>);</div> +<div class="line"> </div> +<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file) < 0)</div> +<div class="line"> perror(<span class="stringliteral">"H5Fclose failed."</span>);</div> +<div class="line"> }</div> +<div class="line"> <span class="keywordflow">else</span></div> +<div class="line"> ret_val = EXIT_FAILURE;</div> +<div class="line"> }</div> +<div class="ttc" id="a_h5_fpublic_8h_html_a2d963b599894f684571fbd4d5e8a96a2a434ca8def77a117013577c8cec6af0d8"><div class="ttname"><a href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2a434ca8def77a117013577c8cec6af0d8">H5F_LIBVER_V18</a></div><div class="ttdeci">@ H5F_LIBVER_V18</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:187</div></div> +<div class="ttc" id="a_h5_fpublic_8h_html_a2d963b599894f684571fbd4d5e8a96a2abed98059b4a02d048b1eb3985fba5fa1"><div class="ttname"><a href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2abed98059b4a02d048b1eb3985fba5fa1">H5F_LIBVER_EARLIEST</a></div><div class="ttdeci">@ H5F_LIBVER_EARLIEST</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:186</div></div> +<div class="ttc" id="agroup___h5_f_html_ga4b833c33fe2e141a26b6f2ad559d3610"><div class="ttname"><a href="group___h5_f.html#ga4b833c33fe2e141a26b6f2ad559d3610">H5Fset_libver_bounds</a></div><div class="ttdeci">herr_t H5Fset_libver_bounds(hid_t file_id, H5F_libver_t low, H5F_libver_t high)</div><div class="ttdoc">Enables the switch of version bounds setting for a file.</div></div> +</div><!-- fragment --> </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.10.2 </dd></dl> + +</div> +</div> +<a id="gae8f807d3f04a33f132ffb6c5295e897f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae8f807d3f04a33f132ffb6c5295e897f">◆ </a></span>H5Funmount()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Funmount </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>loc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Unounts an HDF5 file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">loc</td><td>Location identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the mount point</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>Given a mount point, <a class="el" href="group___h5_f.html#gae8f807d3f04a33f132ffb6c5295e897f" title="Unounts an HDF5 file.">H5Funmount()</a> dissociates the mount point's file from the file mounted there. This function does not close either file.</p> +<p>The mount point can be either the group in the parent or the root group of the mounted file (both groups have the same name). If the mount point was opened before the mount then it is the group in the parent; if it was opened after the mount then it is the root group of the child. </p> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + </ul> +</div> +</body> +</html> |