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_o.html | |
| parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
| download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 | |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'group___j_h5_o.html')
| -rw-r--r-- | group___j_h5_o.html | 2212 |
1 files changed, 2212 insertions, 0 deletions
diff --git a/group___j_h5_o.html b/group___j_h5_o.html new file mode 100644 index 0000000..f9761b8 --- /dev/null +++ b/group___j_h5_o.html @@ -0,0 +1,2212 @@ +<!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 Object (H5O) 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_o.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 Object (H5O) 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_o.html">Objects (H5O)</a>, C-API</dd> +<dd> +<a class="el" href="_h5_o__u_g.html">The HDF5 Objects</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:ga50ef6087d71a126482a43b62cb69c9b6"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga50ef6087d71a126482a43b62cb69c9b6">H5Oclose</a> (long object_id) throws HDF5LibraryException </td></tr> +<tr class="separator:ga50ef6087d71a126482a43b62cb69c9b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga632f7cbbcaf15292dc734ac4afcd66b0"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga632f7cbbcaf15292dc734ac4afcd66b0">H5Ocopy</a> (long src_loc_id, String src_name, long dst_loc_id, String dst_name, long ocpypl_id, long lcpl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga632f7cbbcaf15292dc734ac4afcd66b0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab872f7cc3d77945f3a4b85c250154d4d"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gab872f7cc3d77945f3a4b85c250154d4d">H5Oget_comment</a> (long obj_id) throws HDF5LibraryException, IllegalArgumentException</td></tr> +<tr class="separator:gab872f7cc3d77945f3a4b85c250154d4d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga574e0f07408bce765cc0980fa1841518"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga574e0f07408bce765cc0980fa1841518">H5Oset_comment</a> (long obj_id, String comment) throws HDF5LibraryException</td></tr> +<tr class="separator:ga574e0f07408bce765cc0980fa1841518"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1b627c605dc098a49a12826e7de52158"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga1b627c605dc098a49a12826e7de52158">H5Oget_comment_by_name</a> (long loc_id, String name, long lapl_id) throws HDF5LibraryException, IllegalArgumentException, NullPointerException</td></tr> +<tr class="separator:ga1b627c605dc098a49a12826e7de52158"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaef7ead6cb2131550d32a147a14b1e29c"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gaef7ead6cb2131550d32a147a14b1e29c">H5Oset_comment_by_name</a> (long loc_id, String name, String comment, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gaef7ead6cb2131550d32a147a14b1e29c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga44842663b1ea67f29a7fab54b04c7283"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga44842663b1ea67f29a7fab54b04c7283">H5Oget_info</a> (long loc_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga44842663b1ea67f29a7fab54b04c7283"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1bc7f1e6b0871e371d35bd4868e9fb5e"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga1bc7f1e6b0871e371d35bd4868e9fb5e">H5Oget_info</a> (long loc_id, int fields) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga1bc7f1e6b0871e371d35bd4868e9fb5e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae12be4c91db0028d25fad731a8eea9dc"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gae12be4c91db0028d25fad731a8eea9dc">H5Oget_info_by_idx</a> (long loc_id, String group_name, int idx_type, int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gae12be4c91db0028d25fad731a8eea9dc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga842a21e9372c6f409d857a91ed5e25fd"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga842a21e9372c6f409d857a91ed5e25fd">H5Oget_info_by_idx</a> (long loc_id, String group_name, int idx_type, int order, long n, int fields, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga842a21e9372c6f409d857a91ed5e25fd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa55b4db2c7ffa71dad5584c3ec05cb5f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gaa55b4db2c7ffa71dad5584c3ec05cb5f">H5Oget_info_by_name</a> (long loc_id, String name, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gaa55b4db2c7ffa71dad5584c3ec05cb5f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf6c3a7a6e33259564607d45433df7ae1"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gaf6c3a7a6e33259564607d45433df7ae1">H5Oget_info_by_name</a> (long loc_id, String name, int fields, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gaf6c3a7a6e33259564607d45433df7ae1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga94bdd93cc05b015fa7656e5744aae26e"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga94bdd93cc05b015fa7656e5744aae26e">H5Olink</a> (long obj_id, long new_loc_id, String new_name, long lcpl_id, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga94bdd93cc05b015fa7656e5744aae26e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaf266e9d22937717f4f69085491c842a"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gaaf266e9d22937717f4f69085491c842a">H5Oopen</a> (long loc_id, String name, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gaaf266e9d22937717f4f69085491c842a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab1a82da588a819406428a77e3ff35328"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gab1a82da588a819406428a77e3ff35328">H5Ovisit</a> (long obj_id, int idx_type, int order, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__t.html">H5O_iterate_t</a> op, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__opdata__t.html">H5O_iterate_opdata_t</a> op_data) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gab1a82da588a819406428a77e3ff35328"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga665efb0fed052a9a6e972a4645d3b4e0"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga665efb0fed052a9a6e972a4645d3b4e0">H5Ovisit</a> (long obj_id, int idx_type, int order, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__t.html">H5O_iterate_t</a> op, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__opdata__t.html">H5O_iterate_opdata_t</a> op_data, int fields) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga665efb0fed052a9a6e972a4645d3b4e0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadb6b7058a0dc46a5ace767652e630ef7"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gadb6b7058a0dc46a5ace767652e630ef7">H5Ovisit_by_name</a> (long loc_id, String obj_name, int idx_type, int order, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__t.html">H5O_iterate_t</a> op, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__opdata__t.html">H5O_iterate_opdata_t</a> op_data, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gadb6b7058a0dc46a5ace767652e630ef7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4d8d5b3f8f08cd0429ac25372a1b5f0c"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga4d8d5b3f8f08cd0429ac25372a1b5f0c">H5Ovisit_by_name</a> (long loc_id, String obj_name, int idx_type, int order, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__t.html">H5O_iterate_t</a> op, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__opdata__t.html">H5O_iterate_opdata_t</a> op_data, int fields, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga4d8d5b3f8f08cd0429ac25372a1b5f0c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga48dcf437ed1c2f9aa2f24783775eaa94"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga48dcf437ed1c2f9aa2f24783775eaa94">H5Oexists_by_name</a> (long loc_id, String obj_name, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga48dcf437ed1c2f9aa2f24783775eaa94"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac84ea6a0089083be97155766c0d125c4"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gac84ea6a0089083be97155766c0d125c4">H5Odecr_refcount</a> (long object_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gac84ea6a0089083be97155766c0d125c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga189d5453dd1e85ee94935f68d36ea25d"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga189d5453dd1e85ee94935f68d36ea25d">H5Oincr_refcount</a> (long object_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga189d5453dd1e85ee94935f68d36ea25d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga41a769bddd45f3ac8a79f662db01a3ed"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga41a769bddd45f3ac8a79f662db01a3ed">H5Oopen_by_token</a> (long loc_id, <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__token__t.html">H5O_token_t</a> token) throws HDF5LibraryException </td></tr> +<tr class="separator:ga41a769bddd45f3ac8a79f662db01a3ed"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafb13bde67e51d676e5c962fe0b67b167"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gafb13bde67e51d676e5c962fe0b67b167">H5Oopen_by_idx</a> (long loc_id, String group_name, int idx_type, int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gafb13bde67e51d676e5c962fe0b67b167"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa72870a0c608394226e08436644a9972"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gaa72870a0c608394226e08436644a9972">H5Oflush</a> (long object_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gaa72870a0c608394226e08436644a9972"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa56bdfaf01980def33f738c932a0ff0f"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gaa56bdfaf01980def33f738c932a0ff0f">H5Orefresh</a> (long object_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gaa56bdfaf01980def33f738c932a0ff0f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad5542429070044fc1ceff1051575775d"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gad5542429070044fc1ceff1051575775d">H5Odisable_mdc_flushes</a> (long object_id)</td></tr> +<tr class="separator:gad5542429070044fc1ceff1051575775d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga44046a82735d091bc209e5cbeb08b47e"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga44046a82735d091bc209e5cbeb08b47e">H5Oenable_mdc_flushes</a> (long object_id)</td></tr> +<tr class="separator:ga44046a82735d091bc209e5cbeb08b47e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabdc4a632fb1067727b0ce3ae25d979a4"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gabdc4a632fb1067727b0ce3ae25d979a4">H5Oare_mdc_flushes_disabled</a> (long object_id)</td></tr> +<tr class="separator:gabdc4a632fb1067727b0ce3ae25d979a4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad03be5a3c8b0f5f50f637b060dbe9fe9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#gad03be5a3c8b0f5f50f637b060dbe9fe9">H5Oget_native_info</a> (long loc_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gad03be5a3c8b0f5f50f637b060dbe9fe9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga42763aa19a3bffb719bc3327cb912437"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga42763aa19a3bffb719bc3327cb912437">H5Oget_native_info</a> (long loc_id, int fields) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga42763aa19a3bffb719bc3327cb912437"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5818e1b3506e6d6b5a650eef0443df8e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga5818e1b3506e6d6b5a650eef0443df8e">H5Oget_native_info_by_idx</a> (long loc_id, String group_name, int idx_type, int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga5818e1b3506e6d6b5a650eef0443df8e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga91f551f07cc8692db19a840ce115a3ec"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga91f551f07cc8692db19a840ce115a3ec">H5Oget_native_info_by_idx</a> (long loc_id, String group_name, int idx_type, int order, long n, int fields, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga91f551f07cc8692db19a840ce115a3ec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0b08cf11499df5af61ecc1c1aca157a1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga0b08cf11499df5af61ecc1c1aca157a1">H5Oget_native_info_by_name</a> (long loc_id, String name, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga0b08cf11499df5af61ecc1c1aca157a1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga50030e99738cdfc811e38ceba26ddd25"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_o.html#ga50030e99738cdfc811e38ceba26ddd25">H5Oget_native_info_by_name</a> (long loc_id, String name, int fields, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga50030e99738cdfc811e38ceba26ddd25"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="gabdc4a632fb1067727b0ce3ae25d979a4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabdc4a632fb1067727b0ce3ae25d979a4">◆ </a></span>H5Oare_mdc_flushes_disabled()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Oare_mdc_flushes_disabled </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>object_id</em></td><td>)</td> + <td></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>H5Oare_mdc_flushes_disabled retrieve the object's "cork" status.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">object_id</td><td>IN: Identifier of the object to be flushed.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the cork status TRUE if mdc flushes for the object is disabled FALSE if mdc flushes for the object is not disabled </dd></dl> + +</div> +</div> +<a id="ga50ef6087d71a126482a43b62cb69c9b6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga50ef6087d71a126482a43b62cb69c9b6">◆ </a></span>H5Oclose()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int H5Oclose </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>object_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>H5Oclose closes the group, dataset, or named datatype specified.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">object_id</td><td>IN: Object identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>non-negative on success</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="ga632f7cbbcaf15292dc734ac4afcd66b0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga632f7cbbcaf15292dc734ac4afcd66b0">◆ </a></span>H5Ocopy()</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 H5Ocopy </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>src_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>src_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>dst_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>dst_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>ocpypl_id</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></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>H5Ocopy copies the group, dataset or named datatype specified from the file or group specified by source location to the destination location.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">src_loc_id</td><td>IN: Object identifier indicating the location of the source object to be copied </td></tr> + <tr><td class="paramname">src_name</td><td>IN: Name of the source object to be copied </td></tr> + <tr><td class="paramname">dst_loc_id</td><td>IN: Location identifier specifying the destination </td></tr> + <tr><td class="paramname">dst_name</td><td>IN: Name to be assigned to the new copy </td></tr> + <tr><td class="paramname">ocpypl_id</td><td>IN: Object copy property list </td></tr> + <tr><td class="paramname">lcpl_id</td><td>IN: Link creation property list for the new hard link</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac84ea6a0089083be97155766c0d125c4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac84ea6a0089083be97155766c0d125c4">◆ </a></span>H5Odecr_refcount()</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 H5Odecr_refcount </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>object_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>H5Odecr_refcount decrements the hard link reference count for an object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">object_id</td><td>IN: Object identifier</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="gad5542429070044fc1ceff1051575775d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad5542429070044fc1ceff1051575775d">◆ </a></span>H5Odisable_mdc_flushes()</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 H5Odisable_mdc_flushes </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>object_id</em></td><td>)</td> + <td></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>H5Odisable_mdc_flushes corks an object, keeping dirty entries associated with the object in the metadata cache.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">object_id</td><td>IN: Identifier of the object to be corked. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga44046a82735d091bc209e5cbeb08b47e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga44046a82735d091bc209e5cbeb08b47e">◆ </a></span>H5Oenable_mdc_flushes()</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 H5Oenable_mdc_flushes </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>object_id</em></td><td>)</td> + <td></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>H5Oenable_mdc_flushes uncorks an object, keeping dirty entries associated with the object in the metadata cache.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">object_id</td><td>IN: Identifier of the object to be uncorked. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga48dcf437ed1c2f9aa2f24783775eaa94"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga48dcf437ed1c2f9aa2f24783775eaa94">◆ </a></span>H5Oexists_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 boolean H5Oexists_by_name </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>obj_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>H5Oexists_by_name is used by an application to check that an existing link resolves to an object. Primarily, it is designed to check for dangling soft, external, or user-defined links.</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">obj_name</td><td>IN: Relative path to the object </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns TRUE or FALSE 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="gaa72870a0c608394226e08436644a9972"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa72870a0c608394226e08436644a9972">◆ </a></span>H5Oflush()</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 H5Oflush </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>object_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>H5Oflush causes all buffers associated with an object to be immediately flushed to disk without removing the data from the cache. object_id can be any named object associated with an HDF5 file including a dataset, a group, or a committed datatype.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">object_id</td><td>IN: Identifier of the object 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="gab872f7cc3d77945f3a4b85c250154d4d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab872f7cc3d77945f3a4b85c250154d4d">◆ </a></span>H5Oget_comment()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native String H5Oget_comment </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Oget_comment retrieves the comment for the specified object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: File or group identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the comment</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="ga1b627c605dc098a49a12826e7de52158"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1b627c605dc098a49a12826e7de52158">◆ </a></span>H5Oget_comment_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 String H5Oget_comment_by_name </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>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>, IllegalArgumentException, 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>H5Oget_comment_by_name retrieves the comment for an object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier of a file, group, dataset, or named datatype. </td></tr> + <tr><td class="paramname">name</td><td>IN: Relative name of the object whose comment is to be set or reset. </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list identifier.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the comment</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="ga44842663b1ea67f29a7fab54b04c7283"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga44842663b1ea67f29a7fab54b04c7283">◆ </a></span>H5Oget_info() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> H5Oget_info </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_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>, 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>H5Oget_info retrieves the metadata for an object specified by an identifier.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier for target object</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="ga1bc7f1e6b0871e371d35bd4868e9fb5e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1bc7f1e6b0871e371d35bd4868e9fb5e">◆ </a></span>H5Oget_info() <span class="overload">[2/2]</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 native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> H5Oget_info </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">int </td> + <td class="paramname"><em>fields</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>H5Oget_info retrieves the metadata for an object specified by an identifier.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier for target object </td></tr> + <tr><td class="paramname">fields</td><td>IN: Object fields to select</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="ga842a21e9372c6f409d857a91ed5e25fd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga842a21e9372c6f409d857a91ed5e25fd">◆ </a></span>H5Oget_info_by_idx() <span class="overload">[1/2]</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 native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> H5Oget_info_by_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>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">int </td> + <td class="paramname"><em>fields</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>H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.</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">group_name</td><td>IN: Name of group, relative to loc_id, in which object is located </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: Object to open </td></tr> + <tr><td class="paramname">fields</td><td>IN: Object fields to select </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="gae12be4c91db0028d25fad731a8eea9dc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae12be4c91db0028d25fad731a8eea9dc">◆ </a></span>H5Oget_info_by_idx() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> H5Oget_info_by_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>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>H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.</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">group_name</td><td>IN: Name of group, relative to loc_id, in which object is located </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: Object to open </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="gaf6c3a7a6e33259564607d45433df7ae1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf6c3a7a6e33259564607d45433df7ae1">◆ </a></span>H5Oget_info_by_name() <span class="overload">[1/2]</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 native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> H5Oget_info_by_name </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>fields</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>H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and relative name.</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 location of group in which object is located </td></tr> + <tr><td class="paramname">name</td><td>IN: Relative name of group </td></tr> + <tr><td class="paramname">fields</td><td>IN: Object fields to select </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="gaa55b4db2c7ffa71dad5584c3ec05cb5f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa55b4db2c7ffa71dad5584c3ec05cb5f">◆ </a></span>H5Oget_info_by_name() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__info__t.html">H5O_info_t</a> H5Oget_info_by_name </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>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>H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and relative name.</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 location of group in which object is located </td></tr> + <tr><td class="paramname">name</td><td>IN: Relative name of group </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="gad03be5a3c8b0f5f50f637b060dbe9fe9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad03be5a3c8b0f5f50f637b060dbe9fe9">◆ </a></span>H5Oget_native_info() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> H5Oget_native_info </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_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>, 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>H5Oget_native_info retrieves the native HDF5-specific metadata for an HDF5 object specified by an identifier. Native HDF5-specific metadata includes things like object header information and object storage layout information.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier for target object</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="ga42763aa19a3bffb719bc3327cb912437"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga42763aa19a3bffb719bc3327cb912437">◆ </a></span>H5Oget_native_info() <span class="overload">[2/2]</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 native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> H5Oget_native_info </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">int </td> + <td class="paramname"><em>fields</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>H5Oget_native_info retrieves the native HDF5-specific metadata for an HDF5 object specified by an identifier. Native HDF5-specific metadata includes things like object header information and object storage layout information.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier for target object </td></tr> + <tr><td class="paramname">fields</td><td>IN: Object fields to select</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="ga91f551f07cc8692db19a840ce115a3ec"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga91f551f07cc8692db19a840ce115a3ec">◆ </a></span>H5Oget_native_info_by_idx() <span class="overload">[1/2]</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 native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> H5Oget_native_info_by_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>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">int </td> + <td class="paramname"><em>fields</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>H5Oget_native_info_by_idx retrieves the native HDF5-specific metadata for an HDF5 object, identifying the object by an index position. Native HDF5-specific metadata includes things like object header information and object storage layout information.</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">group_name</td><td>IN: Name of group, relative to loc_id, in which object is located </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: Object to open </td></tr> + <tr><td class="paramname">fields</td><td>IN: Object fields to select </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="ga5818e1b3506e6d6b5a650eef0443df8e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5818e1b3506e6d6b5a650eef0443df8e">◆ </a></span>H5Oget_native_info_by_idx() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> H5Oget_native_info_by_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>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>H5Oget_native_info_by_idx retrieves the native HDF5-specific metadata for an HDF5 object, identifying the object by an index position. Native HDF5-specific metadata includes things like object header information and object storage layout information.</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">group_name</td><td>IN: Name of group, relative to loc_id, in which object is located </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: Object to open </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="ga50030e99738cdfc811e38ceba26ddd25"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga50030e99738cdfc811e38ceba26ddd25">◆ </a></span>H5Oget_native_info_by_name() <span class="overload">[1/2]</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 native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> H5Oget_native_info_by_name </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>fields</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>H5Oget_native_info_by_name retrieves the native HDF5-specific metadata for an HDF5 object, identifying the object by location and relative name. Native HDF5-specific metadata includes things like object header information and object storage layout information.</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 location of group in which object is located </td></tr> + <tr><td class="paramname">name</td><td>IN: Relative name of group </td></tr> + <tr><td class="paramname">fields</td><td>IN: Object fields to select </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="ga0b08cf11499df5af61ecc1c1aca157a1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0b08cf11499df5af61ecc1c1aca157a1">◆ </a></span>H5Oget_native_info_by_name() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__native__info__t.html">H5O_native_info_t</a> H5Oget_native_info_by_name </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>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>H5Oget_native_info_by_name retrieves the native HDF5-specific metadata for an HDF5 object, identifying the object by location and relative name. Native HDF5-specific metadata includes things like object header information and object storage layout information.</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 location of group in which object is located </td></tr> + <tr><td class="paramname">name</td><td>IN: Relative name of group </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>object information</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="ga189d5453dd1e85ee94935f68d36ea25d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga189d5453dd1e85ee94935f68d36ea25d">◆ </a></span>H5Oincr_refcount()</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 H5Oincr_refcount </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>object_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>H5Oincr_refcount increments the hard link reference count for an object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">object_id</td><td>IN: Object identifier</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="ga94bdd93cc05b015fa7656e5744aae26e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga94bdd93cc05b015fa7656e5744aae26e">◆ </a></span>H5Olink()</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 H5Olink </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>new_loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>new_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>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>H5Olink creates a new hard link to an object in an HDF5 file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Object to be linked. </td></tr> + <tr><td class="paramname">new_loc_id</td><td>IN: File or group identifier specifying location at which object is to be linked. </td></tr> + <tr><td class="paramname">new_name</td><td>IN: Relative name of link to be created. </td></tr> + <tr><td class="paramname">lcpl_id</td><td>IN: Link creation property list identifier. </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaaf266e9d22937717f4f69085491c842a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaaf266e9d22937717f4f69085491c842a">◆ </a></span>H5Oopen()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Oopen </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>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>H5Oopen opens a group, dataset, or named datatype specified by a location and a path name.</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: Relative path to the object </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>an object identifier for the opened object</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="gafb13bde67e51d676e5c962fe0b67b167"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafb13bde67e51d676e5c962fe0b67b167">◆ </a></span>H5Oopen_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 long H5Oopen_by_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>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>H5Oopen_by_idx opens the nth object in the group specified.</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">group_name</td><td>IN: Name of group, relative to loc_id, in which object is located </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: Object to open </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Access property list identifier for the link pointing to the object</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>an object identifier for the opened object</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>group_name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga41a769bddd45f3ac8a79f662db01a3ed"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga41a769bddd45f3ac8a79f662db01a3ed">◆ </a></span>H5Oopen_by_token()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Oopen_by_token </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"><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>token</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>H5Oopen_by_token opens a group, dataset, or named datatype using its object token within an HDF5 file.</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">token</td><td>IN: Object's token in the file</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>an object identifier for the opened object</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="gaa56bdfaf01980def33f738c932a0ff0f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa56bdfaf01980def33f738c932a0ff0f">◆ </a></span>H5Orefresh()</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 H5Orefresh </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>object_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>H5Orefresh causes all buffers associated with an object to be cleared and immediately re-loaded with updated contents from disk. This function essentially closes the object, evicts all metadata associated with it from the cache, and then re-opens the object. The reopened object is automatically re-registered with the same ID. object_id can be any named object associated with an HDF5 file including a dataset, a group, or a committed datatype.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">object_id</td><td>IN: Identifier of the object 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> +<a id="ga574e0f07408bce765cc0980fa1841518"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga574e0f07408bce765cc0980fa1841518">◆ </a></span>H5Oset_comment()</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 H5Oset_comment </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>comment</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>H5Oset_comment sets the comment for the specified object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the target object </td></tr> + <tr><td class="paramname">comment</td><td>IN: The new comment.</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> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>As of HDF5 1.8 in favor of object attributes. </dd></dl> + +</div> +</div> +<a id="gaef7ead6cb2131550d32a147a14b1e29c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaef7ead6cb2131550d32a147a14b1e29c">◆ </a></span>H5Oset_comment_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 void H5Oset_comment_by_name </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>comment</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>H5Oset_comment_by_name sets the comment for the specified object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier of a file, group, dataset, or named datatype. </td></tr> + <tr><td class="paramname">name</td><td>IN: Relative name of the object whose comment is to be set or reset. </td></tr> + <tr><td class="paramname">comment</td><td>IN: The new comment. </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list identifier.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null.</td></tr> + </table> + </dd> +</dl> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>As of HDF5 1.8 in favor of object attributes. </dd></dl> + +</div> +</div> +<a id="gab1a82da588a819406428a77e3ff35328"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab1a82da588a819406428a77e3ff35328">◆ </a></span>H5Ovisit() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int H5Ovisit </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</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"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__t.html">H5O_iterate_t</a> </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__opdata__t.html">H5O_iterate_opdata_t</a> </td> + <td class="paramname"><em>op_data</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>H5Ovisit recursively visits all objects accessible from a specified object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object at which the recursive iteration begins. </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: Type of index </td></tr> + <tr><td class="paramname">order</td><td>IN: Order of iteration within index </td></tr> + <tr><td class="paramname">op</td><td>IN: Callback function passing data regarding the object to the calling application </td></tr> + <tr><td class="paramname">op_data</td><td>IN: User-defined pointer to data required by the application for its processing of the object</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</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="ga665efb0fed052a9a6e972a4645d3b4e0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga665efb0fed052a9a6e972a4645d3b4e0">◆ </a></span>H5Ovisit() <span class="overload">[2/2]</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 native int H5Ovisit </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</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"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__t.html">H5O_iterate_t</a> </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__opdata__t.html">H5O_iterate_opdata_t</a> </td> + <td class="paramname"><em>op_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>fields</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>H5Ovisit recursively visits all objects accessible from a specified object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object at which the recursive iteration begins. </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: Type of index </td></tr> + <tr><td class="paramname">order</td><td>IN: Order of iteration within index </td></tr> + <tr><td class="paramname">op</td><td>IN: Callback function passing data regarding the object to the calling application </td></tr> + <tr><td class="paramname">op_data</td><td>IN: User-defined pointer to data required by the application for its processing of the object </td></tr> + <tr><td class="paramname">fields</td><td>IN: Object fields to select</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</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="ga4d8d5b3f8f08cd0429ac25372a1b5f0c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4d8d5b3f8f08cd0429ac25372a1b5f0c">◆ </a></span>H5Ovisit_by_name() <span class="overload">[1/2]</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 native int H5Ovisit_by_name </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>obj_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"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__t.html">H5O_iterate_t</a> </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__opdata__t.html">H5O_iterate_opdata_t</a> </td> + <td class="paramname"><em>op_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>fields</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>H5Ovisit_by_name recursively visits all objects starting from a specified object.</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">obj_name</td><td>IN: Relative path to the object </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: Type of index </td></tr> + <tr><td class="paramname">order</td><td>IN: Order of iteration within index </td></tr> + <tr><td class="paramname">op</td><td>IN: Callback function passing data regarding the object to the calling application </td></tr> + <tr><td class="paramname">op_data</td><td>IN: User-defined pointer to data required by the application for its processing of the object </td></tr> + <tr><td class="paramname">fields</td><td>IN: Object fields to select </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</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="gadb6b7058a0dc46a5ace767652e630ef7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadb6b7058a0dc46a5ace767652e630ef7">◆ </a></span>H5Ovisit_by_name() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int H5Ovisit_by_name </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>obj_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"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__t.html">H5O_iterate_t</a> </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_o__iterate__opdata__t.html">H5O_iterate_opdata_t</a> </td> + <td class="paramname"><em>op_data</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>H5Ovisit_by_name recursively visits all objects starting from a specified object.</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">obj_name</td><td>IN: Relative path to the object </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: Type of index </td></tr> + <tr><td class="paramname">order</td><td>IN: Order of iteration within index </td></tr> + <tr><td class="paramname">op</td><td>IN: Callback function passing data regarding the object to the calling application </td></tr> + <tr><td class="paramname">op_data</td><td>IN: User-defined pointer to data required by the application for its processing of the object </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated 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> |