diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
| commit | d12e43bc201e15edffcdf94fe820aeae6ab44882 (patch) | |
| tree | 90aa12006b20849b65b7bc8e3d4fe60a488f7247 /group___j_h5_g.html | |
| parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
| download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 | |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'group___j_h5_g.html')
| -rw-r--r-- | group___j_h5_g.html | 1249 |
1 files changed, 1249 insertions, 0 deletions
diff --git a/group___j_h5_g.html b/group___j_h5_g.html new file mode 100644 index 0000000..43e9ff1 --- /dev/null +++ b/group___j_h5_g.html @@ -0,0 +1,1249 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>HDF5: Java Group (H5G) Interface</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(function() { init_search(); }); +/* @license-end */ +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="hdf5doxy.css" rel="stylesheet" type="text/css"> +<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/> + --> +<script type="text/javascript" src="hdf5_navtree_hacks.js"></script> +</head> +<body> +<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a> +  <span id="projectnumber">1.15.0.ab4d2ae</span> + </div> + <div id="projectbrief">API Reference</div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.svg" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> + </span> + </div> +</td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('group___j_h5_g.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Java Group (H5G) Interface</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_g.html">Groups (H5G)</a>, C-API</dd> +<dd> +<a class="el" href="_h5_g__u_g.html">HDF5 Groups</a>, User Guide </dd></dl> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ga433f956d1b0c5fa81cefc1e390808668"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga433f956d1b0c5fa81cefc1e390808668">H5Gclose</a> (long group_id) throws HDF5LibraryException </td></tr> +<tr class="separator:ga433f956d1b0c5fa81cefc1e390808668"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf8763b10fec82a1066c37eda26570b37"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#gaf8763b10fec82a1066c37eda26570b37">H5Gcreate</a> (long loc_id, String name, long lcpl_id, long gcpl_id, long gapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gaf8763b10fec82a1066c37eda26570b37"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3be292a6445c23dad1373ca5bb9b227c"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga3be292a6445c23dad1373ca5bb9b227c">H5Gcreate_anon</a> (long loc_id, long gcpl_id, long gapl_id) throws HDF5LibraryException </td></tr> +<tr class="separator:ga3be292a6445c23dad1373ca5bb9b227c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0e889e318db767ec0554794d05818581"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga0e889e318db767ec0554794d05818581">H5Gget_create_plist</a> (long group_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga0e889e318db767ec0554794d05818581"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaece6d1057c42630d336dad0f3915b337"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_g__info__t.html">H5G_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#gaece6d1057c42630d336dad0f3915b337">H5Gget_info</a> (long group_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gaece6d1057c42630d336dad0f3915b337"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0ca8f9ea2f9e175f1b63dc8c71a63bbf"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_g__info__t.html">H5G_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga0ca8f9ea2f9e175f1b63dc8c71a63bbf">H5Gget_info_by_idx</a> (long group_id, String group_name, int idx_type, int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga0ca8f9ea2f9e175f1b63dc8c71a63bbf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga27f51405659ca1bf6503b03a802fed04"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_g__info__t.html">H5G_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga27f51405659ca1bf6503b03a802fed04">H5Gget_info_by_name</a> (long group_id, String name, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga27f51405659ca1bf6503b03a802fed04"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga87b461e7a741e2bb4a5c7513ed370a5d"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga87b461e7a741e2bb4a5c7513ed370a5d">H5Gget_obj_info_all</a> (long loc_id, String name, String[] objNames, int[] objTypes, <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] tokens) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga87b461e7a741e2bb4a5c7513ed370a5d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5079a661cd7979ad5b7246c63f492e31"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga5079a661cd7979ad5b7246c63f492e31">H5Gget_obj_info_all</a> (long loc_id, String name, String[] objNames, int[] objTypes, int[] ltype, <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] tokens, int indx_type) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga5079a661cd7979ad5b7246c63f492e31"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga46a64aa2f58e3c1982191b4e8c7dc7a6"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga46a64aa2f58e3c1982191b4e8c7dc7a6">H5Gget_obj_info_all</a> (long loc_id, String name, String[] objNames, int[] objTypes, int[] ltype, long[] fno, <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] tokens, int indx_type) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga46a64aa2f58e3c1982191b4e8c7dc7a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3bf5679e85d3590e0c84b7317717e671"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga3bf5679e85d3590e0c84b7317717e671">H5Gget_obj_info_full</a> (long loc_id, String name, String[] objNames, int[] objTypes, int[] ltype, long[] fno, <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] tokens, int indx_type, int indx_order) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga3bf5679e85d3590e0c84b7317717e671"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabecf95e812876d3bb286f9aac115b2b7"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#gabecf95e812876d3bb286f9aac115b2b7">H5Gget_obj_info_idx</a> (long loc_id, String name, int idx, String[] oname, int[] type) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gabecf95e812876d3bb286f9aac115b2b7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5ba0732cadba0407ab34cb65ce7ab7f7"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga5ba0732cadba0407ab34cb65ce7ab7f7">H5Gget_obj_info_max</a> (long loc_id, String[] objNames, int[] objTypes, int[] lnkTypes, <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] objToken, long objMax) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga5ba0732cadba0407ab34cb65ce7ab7f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8c944a4facf4977e490f540fb95edcc5"><td class="memItemLeft" align="right" valign="top">static synchronized long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga8c944a4facf4977e490f540fb95edcc5">H5Gn_members</a> (long loc_id, String name) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga8c944a4facf4977e490f540fb95edcc5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gace85ef3beec51c23830a13ef48b675a5"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#gace85ef3beec51c23830a13ef48b675a5">H5Gopen</a> (long loc_id, String name, long gapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gace85ef3beec51c23830a13ef48b675a5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4185fb6d933bc02871e35b029047a797"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#ga4185fb6d933bc02871e35b029047a797">H5Gflush</a> (long group_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga4185fb6d933bc02871e35b029047a797"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa00f4af3b70ba95e672cc066e81a7b4b"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_g.html#gaa00f4af3b70ba95e672cc066e81a7b4b">H5Grefresh</a> (long group_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gaa00f4af3b70ba95e672cc066e81a7b4b"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="ga433f956d1b0c5fa81cefc1e390808668"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga433f956d1b0c5fa81cefc1e390808668">◆ </a></span>H5Gclose()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int H5Gclose </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>group_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gclose releases resources used by a group which was opened by a call to <a class="el" href="group___j_h5_g.html#gaf8763b10fec82a1066c37eda26570b37">H5Gcreate()</a> or <a class="el" href="group___j_h5_g.html#gace85ef3beec51c23830a13ef48b675a5">H5Gopen()</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">group_id</td><td>Group identifier to release.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaf8763b10fec82a1066c37eda26570b37"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf8763b10fec82a1066c37eda26570b37">◆ </a></span>H5Gcreate()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Gcreate </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lcpl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>gcpl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>gapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gcreate creates a new group with the specified name at the specified location, loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: The file or group identifier. </td></tr> + <tr><td class="paramname">name</td><td>IN: The absolute or relative name of the new group. </td></tr> + <tr><td class="paramname">lcpl_id</td><td>IN: Identifier of link creation property list. </td></tr> + <tr><td class="paramname">gcpl_id</td><td>IN: Identifier of group creation property list. </td></tr> + <tr><td class="paramname">gapl_id</td><td>IN: Identifier of group access property list. (No group access properties have been implemented at this time; use H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a valid group identifier</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga3be292a6445c23dad1373ca5bb9b227c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3be292a6445c23dad1373ca5bb9b227c">◆ </a></span>H5Gcreate_anon()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Gcreate_anon </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>gcpl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>gapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gcreate_anon creates a new empty group in the file specified by loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: File or group identifier specifying the file in which the new group is to be created. </td></tr> + <tr><td class="paramname">gcpl_id</td><td>IN: Identifier of group creation property list. </td></tr> + <tr><td class="paramname">gapl_id</td><td>IN: Identifier of group access property list. (No group access properties have been implemented at this time; use H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a valid group identifier</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga4185fb6d933bc02871e35b029047a797"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4185fb6d933bc02871e35b029047a797">◆ </a></span>H5Gflush()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Gflush </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>group_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gflush causes all buffers associated with a group to be immediately flushed to disk without removing the data from the cache.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">group_id</td><td>IN: Identifier of the group to be flushed.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0e889e318db767ec0554794d05818581"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0e889e318db767ec0554794d05818581">◆ </a></span>H5Gget_create_plist()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Gget_create_plist </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>group_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gget_create_plist returns an identifier for the group creation property list associated with the group specified by group_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">group_id</td><td>IN: Identifier of the group.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>an identifier for the group's creation property list</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaece6d1057c42630d336dad0f3915b337"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaece6d1057c42630d336dad0f3915b337">◆ </a></span>H5Gget_info()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_g__info__t.html">H5G_info_t</a> H5Gget_info </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>group_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gget_info retrieves information about the group specified by group_id. The information is returned in the group_info struct.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">group_id</td><td>IN: Identifier of the group.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a structure in which group information is returned</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0ca8f9ea2f9e175f1b63dc8c71a63bbf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0ca8f9ea2f9e175f1b63dc8c71a63bbf">◆ </a></span>H5Gget_info_by_idx()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_g__info__t.html">H5G_info_t</a> H5Gget_info_by_idx </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>group_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>group_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>order</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>n</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gget_info_by_idx retrieves information about a group, according to the group's position within an index.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">group_id</td><td>IN: File or group identifier. </td></tr> + <tr><td class="paramname">group_name</td><td>IN: Name of group for which information is to be retrieved. </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: Type of index by which objects are ordered </td></tr> + <tr><td class="paramname">order</td><td>IN: Order of iteration within index </td></tr> + <tr><td class="paramname">n</td><td>IN: Attribute's position in index </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a structure in which group information is returned</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga27f51405659ca1bf6503b03a802fed04"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga27f51405659ca1bf6503b03a802fed04">◆ </a></span>H5Gget_info_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_g__info__t.html">H5G_info_t</a> H5Gget_info_by_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>group_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gget_info_by_name retrieves information about the group group_name located in the file or group specified by loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">group_id</td><td>IN: File or group identifier. </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of group for which information is to be retrieved. </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a structure in which group information is returned</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga87b461e7a741e2bb4a5c7513ed370a5d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga87b461e7a741e2bb4a5c7513ed370a5d">◆ </a></span>H5Gget_obj_info_all() <span class="overload">[1/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Gget_obj_info_all </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>objNames</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>objTypes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] </td> + <td class="paramname"><em>tokens</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>retrieves information of all objects under the group (name) located in the file or group specified by loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: File or group identifier </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of group for which information is to be retrieved </td></tr> + <tr><td class="paramname">objNames</td><td>OUT: Names of all objects under the group, name. </td></tr> + <tr><td class="paramname">objTypes</td><td>OUT: Types of all objects under the group, name. </td></tr> + <tr><td class="paramname">tokens</td><td>OUT: Object token of all objects under the group, name.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of items found</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga5079a661cd7979ad5b7246c63f492e31"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5079a661cd7979ad5b7246c63f492e31">◆ </a></span>H5Gget_obj_info_all() <span class="overload">[2/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Gget_obj_info_all </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>objNames</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>objTypes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>ltype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] </td> + <td class="paramname"><em>tokens</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>indx_type</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>retrieves information of all objects under the group (name) located in the file or group specified by loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: File or group identifier </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of group for which information is to be retrieved </td></tr> + <tr><td class="paramname">objNames</td><td>OUT: Names of all objects under the group, name. </td></tr> + <tr><td class="paramname">objTypes</td><td>OUT: Types of all objects under the group, name. </td></tr> + <tr><td class="paramname">ltype</td><td>OUT: Link type </td></tr> + <tr><td class="paramname">tokens</td><td>OUT: Object token of all objects under the group, name. </td></tr> + <tr><td class="paramname">indx_type</td><td>IN: Index type for iterate</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of items found</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga46a64aa2f58e3c1982191b4e8c7dc7a6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga46a64aa2f58e3c1982191b4e8c7dc7a6">◆ </a></span>H5Gget_obj_info_all() <span class="overload">[3/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Gget_obj_info_all </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>objNames</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>objTypes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>ltype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>fno</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] </td> + <td class="paramname"><em>tokens</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>indx_type</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>retrieves information of all objects under the group (name) located in the file or group specified by loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: File or group identifier </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of group for which information is to be retrieved </td></tr> + <tr><td class="paramname">objNames</td><td>OUT: Names of all objects under the group, name. </td></tr> + <tr><td class="paramname">objTypes</td><td>OUT: Types of all objects under the group, name. </td></tr> + <tr><td class="paramname">ltype</td><td>OUT: Link type </td></tr> + <tr><td class="paramname">fno</td><td>OUT: File number </td></tr> + <tr><td class="paramname">tokens</td><td>OUT: Object token of all objects under the group, name. </td></tr> + <tr><td class="paramname">indx_type</td><td>IN: Index type for iterate</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of items found</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga3bf5679e85d3590e0c84b7317717e671"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3bf5679e85d3590e0c84b7317717e671">◆ </a></span>H5Gget_obj_info_full()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Gget_obj_info_full </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>objNames</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>objTypes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>ltype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>fno</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] </td> + <td class="paramname"><em>tokens</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>indx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>indx_order</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>retrieves information of all objects under the group (name) located in the file or group specified by loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: File or group identifier </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of group for which information is to be retrieved </td></tr> + <tr><td class="paramname">objNames</td><td>OUT: Names of all objects under the group, name. </td></tr> + <tr><td class="paramname">objTypes</td><td>OUT: Types of all objects under the group, name. </td></tr> + <tr><td class="paramname">ltype</td><td>OUT: Link type </td></tr> + <tr><td class="paramname">fno</td><td>OUT: File number </td></tr> + <tr><td class="paramname">tokens</td><td>OUT: Object token of all objects under the group, name. </td></tr> + <tr><td class="paramname">indx_type</td><td>IN: Index type for iterate </td></tr> + <tr><td class="paramname">indx_order</td><td>IN: Index order for iterate</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of items found</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gabecf95e812876d3bb286f9aac115b2b7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabecf95e812876d3bb286f9aac115b2b7">◆ </a></span>H5Gget_obj_info_idx()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Gget_obj_info_idx </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>oname</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>type</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gget_obj_info_idx report the name and type of object with index 'idx' in a Group. The 'idx' corresponds to the index maintained by H5Giterate. Each link is returned, so objects with multiple links will be counted once for each link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: file or group ID. </td></tr> + <tr><td class="paramname">name</td><td>IN: name of the group to iterate, relative to the loc_id </td></tr> + <tr><td class="paramname">idx</td><td>IN: the index of the object to iterate. </td></tr> + <tr><td class="paramname">oname</td><td>OUT: the name of the object </td></tr> + <tr><td class="paramname">type</td><td>OUT: the type of the object</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>non-negative if successful, -1 if not.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga5ba0732cadba0407ab34cb65ce7ab7f7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5ba0732cadba0407ab34cb65ce7ab7f7">◆ </a></span>H5Gget_obj_info_max()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Gget_obj_info_max </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>objNames</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>objTypes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>lnkTypes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a>[] </td> + <td class="paramname"><em>objToken</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>objMax</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>retrieves information of all objects (recurvisely) under the group (name) located in the file or group specified by loc_id up to maximum specified by objMax.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: File or group identifier </td></tr> + <tr><td class="paramname">objNames</td><td>OUT: Names of all objects under the group, name. </td></tr> + <tr><td class="paramname">objTypes</td><td>OUT: Types of all objects under the group, name. </td></tr> + <tr><td class="paramname">lnkTypes</td><td>OUT: Types of all links under the group, name. </td></tr> + <tr><td class="paramname">objToken</td><td>OUT: Object token of all objects under the group, name. </td></tr> + <tr><td class="paramname">objMax</td><td>IN: Maximum number of all objects under the group, name.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of items found</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga8c944a4facf4977e490f540fb95edcc5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8c944a4facf4977e490f540fb95edcc5">◆ </a></span>H5Gn_members()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized long H5Gn_members </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gn_members report the number of objects in a Group. The 'objects' include everything that will be visited by H5Giterate. Each link is returned, so objects with multiple links will be counted once for each link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>file or group ID. </td></tr> + <tr><td class="paramname">name</td><td>name of the group to iterate, relative to the loc_id</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of members in the group or -1 if error.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gace85ef3beec51c23830a13ef48b675a5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gace85ef3beec51c23830a13ef48b675a5">◆ </a></span>H5Gopen()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Gopen </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>gapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Gopen opens an existing group, name, at the location specified by loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: File or group identifier specifying the location of the group to be opened. </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of group to open. </td></tr> + <tr><td class="paramname">gapl_id</td><td>IN: Identifier of group access property list.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a valid group identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaa00f4af3b70ba95e672cc066e81a7b4b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa00f4af3b70ba95e672cc066e81a7b4b">◆ </a></span>H5Grefresh()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Grefresh </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>group_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Grefresh causes all buffers associated with a group to be cleared and immediately re-loaded with updated contents from disk. This function essentially closes the group, evicts all metadata associated with it from the cache, and then re-opens the group. The reopened group is automatically re-registered with the same ID.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">group_id</td><td>IN: Identifier of the group to be refreshed.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +</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 on Mon Jun 26 2023 19:01:38 for HDF5 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> |