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_r.html | |
| parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
| download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 | |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'group___j_h5_r.html')
| -rw-r--r-- | group___j_h5_r.html | 1298 |
1 files changed, 1298 insertions, 0 deletions
diff --git a/group___j_h5_r.html b/group___j_h5_r.html new file mode 100644 index 0000000..fa5babf --- /dev/null +++ b/group___j_h5_r.html @@ -0,0 +1,1298 @@ +<!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 Reference (H5R) 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_r.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 Reference (H5R) 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_r.html">References (H5R)</a>, C-API</dd> +<dd> +<a class="el" href="_h5_r__u_g.html">The HDF5 References</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:ga88738566330dddadd1541932e35b2c9c"><td class="memItemLeft" align="right" valign="top">static synchronized byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga88738566330dddadd1541932e35b2c9c">H5Rcreate</a> (long loc_id, String name, int ref_type, long space_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException </td></tr> +<tr class="separator:ga88738566330dddadd1541932e35b2c9c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9939e9a8fa78b7dac3088e06ab9c219f"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga9939e9a8fa78b7dac3088e06ab9c219f">H5Rdereference</a> (long dataset, long access_list, int ref_type, byte[] ref) throws HDF5LibraryException, NullPointerException, IllegalArgumentException </td></tr> +<tr class="separator:ga9939e9a8fa78b7dac3088e06ab9c219f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa5d8164dbdcbbc5a2acf3fc83ad4ee73"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#gaa5d8164dbdcbbc5a2acf3fc83ad4ee73">H5Rget_name</a> (long loc_id, int ref_type, byte[] ref, String[] name, long size) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:gaa5d8164dbdcbbc5a2acf3fc83ad4ee73"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga48c4d6cb9e011af084d3c8088b121ac5"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga48c4d6cb9e011af084d3c8088b121ac5">H5Rget_name_string</a> (long loc_id, int ref_type, byte[] ref) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga48c4d6cb9e011af084d3c8088b121ac5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab6198a7c48056fccbc00e7f54505a90a"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#gab6198a7c48056fccbc00e7f54505a90a">H5Rget_obj_type</a> (long loc_id, int ref_type, byte ref[]) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:gab6198a7c48056fccbc00e7f54505a90a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga343e95a84217aa129f141f66e03707d8"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga343e95a84217aa129f141f66e03707d8">H5Rget_region</a> (long loc_id, int ref_type, byte[] ref) throws HDF5LibraryException, NullPointerException, IllegalArgumentException </td></tr> +<tr class="separator:ga343e95a84217aa129f141f66e03707d8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga712d906392ee115dcef8c11ea470f13d"><td class="memItemLeft" align="right" valign="top">static synchronized native byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga712d906392ee115dcef8c11ea470f13d">H5Rcreate_object</a> (long loc_id, String name, long access_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga712d906392ee115dcef8c11ea470f13d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab6aa3ef41b16821519f41f0dac7b2ec4"><td class="memItemLeft" align="right" valign="top">static synchronized native byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#gab6aa3ef41b16821519f41f0dac7b2ec4">H5Rcreate_region</a> (long loc_id, String name, long space_id, long access_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:gab6aa3ef41b16821519f41f0dac7b2ec4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5ef2553872ec42ac800c37c561909dcb"><td class="memItemLeft" align="right" valign="top">static synchronized native byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga5ef2553872ec42ac800c37c561909dcb">H5Rcreate_attr</a> (long loc_id, String name, String attr_name, long access_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga5ef2553872ec42ac800c37c561909dcb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaff067224b53590548c56508a5a7ecfb5"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#gaff067224b53590548c56508a5a7ecfb5">H5Rdestroy</a> (byte[] ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:gaff067224b53590548c56508a5a7ecfb5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab424b2b5016eeb166d92effbc1b2e0da"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#gab424b2b5016eeb166d92effbc1b2e0da">H5Rget_type</a> (byte[] ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:gab424b2b5016eeb166d92effbc1b2e0da"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga69c31372a42b4989fb52fbd72c232259"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga69c31372a42b4989fb52fbd72c232259">H5Requal</a> (byte[] ref1_ptr, byte[] ref2_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga69c31372a42b4989fb52fbd72c232259"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad57fcc20d5304634128f08c5ab47599a"><td class="memItemLeft" align="right" valign="top">static synchronized native byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#gad57fcc20d5304634128f08c5ab47599a">H5Rcopy</a> (byte[] src_ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:gad57fcc20d5304634128f08c5ab47599a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad8f49dcf2c74cd4320898f131414fcef"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#gad8f49dcf2c74cd4320898f131414fcef">H5Ropen_object</a> (byte[] ref_ptr, long rapl_id, long oapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException </td></tr> +<tr class="separator:gad8f49dcf2c74cd4320898f131414fcef"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9813a791d5650c6ee494c79cd15ac717"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga9813a791d5650c6ee494c79cd15ac717">H5Ropen_region</a> (byte[] ref_ptr, long rapl_id, long oapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException </td></tr> +<tr class="separator:ga9813a791d5650c6ee494c79cd15ac717"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabca49bfdf0111ba8e272e169ece85049"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#gabca49bfdf0111ba8e272e169ece85049">H5Ropen_attr</a> (byte[] ref_ptr, long rapl_id, long aapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException </td></tr> +<tr class="separator:gabca49bfdf0111ba8e272e169ece85049"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gade781b210eee63200593a386fd21ac7a"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#gade781b210eee63200593a386fd21ac7a">H5Rget_obj_type3</a> (byte[] ref_ptr, long rapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:gade781b210eee63200593a386fd21ac7a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3000a3fec3972866977a80efe45f780e"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga3000a3fec3972866977a80efe45f780e">H5Rget_file_name</a> (byte[] ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga3000a3fec3972866977a80efe45f780e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2c9e2580f84254da73ba10daecc10e6a"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga2c9e2580f84254da73ba10daecc10e6a">H5Rget_obj_name</a> (byte[] ref_ptr, long rapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga2c9e2580f84254da73ba10daecc10e6a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga051018b5764887581872a12eb616d2de"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_r.html#ga051018b5764887581872a12eb616d2de">H5Rget_attr_name</a> (byte[] ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga051018b5764887581872a12eb616d2de"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="gad57fcc20d5304634128f08c5ab47599a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad57fcc20d5304634128f08c5ab47599a">◆ </a></span>H5Rcopy()</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 byte [] H5Rcopy </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>src_ref_ptr</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, 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>H5Rcopy creates a copy of an existing reference.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">src_ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a valid copy of the reference (byte[]) 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>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga88738566330dddadd1541932e35b2c9c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga88738566330dddadd1541932e35b2c9c">◆ </a></span>H5Rcreate()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized byte [] H5Rcreate </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>ref_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_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, 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>H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name located at loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location identifier used to locate the object being pointed to. </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of object at location loc_id. </td></tr> + <tr><td class="paramname">ref_type</td><td>IN: Type of reference. </td></tr> + <tr><td class="paramname">space_id</td><td>IN: Dataspace identifier with selection.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the reference (byte[]) 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>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga5ef2553872ec42ac800c37c561909dcb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5ef2553872ec42ac800c37c561909dcb">◆ </a></span>H5Rcreate_attr()</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 byte [] H5Rcreate_attr </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>attr_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>access_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, 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>H5Rcreate_attr creates the reference, pointing to the attribute named attr name and attached to the object named name located at loc id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location identifier used to locate the object being pointed to. </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of object at location loc_id. </td></tr> + <tr><td class="paramname">attr_name</td><td>IN: Name of the attribute within the object. </td></tr> + <tr><td class="paramname">access_id</td><td>IN: Object access identifier to the object being pointed to.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the reference (byte[]) 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>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga712d906392ee115dcef8c11ea470f13d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga712d906392ee115dcef8c11ea470f13d">◆ </a></span>H5Rcreate_object()</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 byte [] H5Rcreate_object </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>access_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, 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>H5Rcreate_object creates a reference pointing to the object named name located at loc id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location identifier used to locate the object being pointed to. </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of object at location loc_id. </td></tr> + <tr><td class="paramname">access_id</td><td>IN: Object access identifier to the object being pointed to.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the reference (byte[]) 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>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gab6aa3ef41b16821519f41f0dac7b2ec4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab6aa3ef41b16821519f41f0dac7b2ec4">◆ </a></span>H5Rcreate_region()</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 byte [] H5Rcreate_region </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>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>access_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, 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>H5Rcreate_region creates the reference, pointing to the region represented by space id within the object named name located at loc id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location identifier used to locate the object being pointed to. </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of object at location loc_id. </td></tr> + <tr><td class="paramname">space_id</td><td>IN: Identifies the dataset region that a dataset region reference points to. </td></tr> + <tr><td class="paramname">access_id</td><td>IN: Object access identifier to the object being pointed to.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the reference (byte[]) 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>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9939e9a8fa78b7dac3088e06ab9c219f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9939e9a8fa78b7dac3088e06ab9c219f">◆ </a></span>H5Rdereference()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Rdereference </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>dataset</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>access_list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>ref_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Given a reference to some object, H5Rdereference opens that object and return an identifier.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dataset</td><td>IN: Dataset containing reference object. </td></tr> + <tr><td class="paramname">access_list</td><td>IN: Property list of the object being referenced. </td></tr> + <tr><td class="paramname">ref_type</td><td>IN: The reference type of ref. </td></tr> + <tr><td class="paramname">ref</td><td>IN: reference to an object</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>valid identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>output array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>output array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaff067224b53590548c56508a5a7ecfb5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaff067224b53590548c56508a5a7ecfb5">◆ </a></span>H5Rdestroy()</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 H5Rdestroy </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref_ptr</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, 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>H5Rdestroy destroys a reference and releases resources.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object.</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>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga69c31372a42b4989fb52fbd72c232259"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga69c31372a42b4989fb52fbd72c232259">◆ </a></span>H5Requal()</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 H5Requal </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref1_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref2_ptr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Requal determines whether two references point to the same object, region or attribute.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref1_ptr</td><td>IN: Reference to an object, region or attribute attached to an object. </td></tr> + <tr><td class="paramname">ref2_ptr</td><td>IN: Reference to an object, region or attribute attached to an object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if equal, else false</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>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga051018b5764887581872a12eb616d2de"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga051018b5764887581872a12eb616d2de">◆ </a></span>H5Rget_attr_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 H5Rget_attr_name </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref_ptr</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, 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>H5Rget_attr_name retrieves the attribute name for the object, region or attribute reference pointed to.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the attribute name of the reference</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>array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga3000a3fec3972866977a80efe45f780e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3000a3fec3972866977a80efe45f780e">◆ </a></span>H5Rget_file_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 H5Rget_file_name </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref_ptr</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, 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>H5Rget_file_name retrieves the file name for the object, region or attribute reference pointed to.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the file name of the reference</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>array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaa5d8164dbdcbbc5a2acf3fc83ad4ee73"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa5d8164dbdcbbc5a2acf3fc83ad4ee73">◆ </a></span>H5Rget_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 long H5Rget_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">int </td> + <td class="paramname"><em>ref_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref</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>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Rget_name retrieves a name for the object identified by ref.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier for the dataset containing the reference or for the group that dataset is in. </td></tr> + <tr><td class="paramname">ref_type</td><td>IN: Type of reference. </td></tr> + <tr><td class="paramname">ref</td><td>IN: An object or dataset region reference. </td></tr> + <tr><td class="paramname">name</td><td>OUT: A name associated with the referenced object or dataset region. </td></tr> + <tr><td class="paramname">size</td><td>IN: The size of the name buffer.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value.</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>size is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>Argument is illegal. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga48c4d6cb9e011af084d3c8088b121ac5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga48c4d6cb9e011af084d3c8088b121ac5">◆ </a></span>H5Rget_name_string()</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 H5Rget_name_string </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>ref_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Rget_name_string retrieves a name for the object identified by ref.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier for the dataset containing the reference or for the group that dataset is in. </td></tr> + <tr><td class="paramname">ref_type</td><td>IN: Type of reference. </td></tr> + <tr><td class="paramname">ref</td><td>IN: An object or dataset region reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the name if successful, returning null if no name is associated with the identifier.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>size is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>Argument is illegal. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga2c9e2580f84254da73ba10daecc10e6a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2c9e2580f84254da73ba10daecc10e6a">◆ </a></span>H5Rget_obj_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 H5Rget_obj_name </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>rapl_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, 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>H5Rget_obj_name retrieves the object name for the object, region or attribute reference pointed to.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object. </td></tr> + <tr><td class="paramname">rapl_id</td><td>IN: A reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the object name of the reference</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>array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gab6198a7c48056fccbc00e7f54505a90a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab6198a7c48056fccbc00e7f54505a90a">◆ </a></span>H5Rget_obj_type()</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 H5Rget_obj_type </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>ref_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte </td> + <td class="paramname"><em>ref</em>[] </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Rget_obj_type Given a reference to an object ref, H5Rget_obj_type returns the type of the object pointed to.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: loc_id of the reference object. </td></tr> + <tr><td class="paramname">ref_type</td><td>IN: Type of reference to query. </td></tr> + <tr><td class="paramname">ref</td><td>IN: the reference</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the object type</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>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gade781b210eee63200593a386fd21ac7a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gade781b210eee63200593a386fd21ac7a">◆ </a></span>H5Rget_obj_type3()</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 H5Rget_obj_type3 </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>rapl_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, 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>H5Rget obj type3 retrieves the type of the referenced object pointed to.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object. </td></tr> + <tr><td class="paramname">rapl_id</td><td>IN: A reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the object type</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>array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga343e95a84217aa129f141f66e03707d8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga343e95a84217aa129f141f66e03707d8">◆ </a></span>H5Rget_region()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Rget_region </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>ref_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Given a reference to an object ref, H5Rget_region creates a copy of the dataspace of the dataset pointed to and defines a selection in the copy which is the region pointed to.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: loc_id of the reference object. </td></tr> + <tr><td class="paramname">ref_type</td><td>IN: The reference type of ref. </td></tr> + <tr><td class="paramname">ref</td><td>OUT: the reference to the object and region</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a valid identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gab424b2b5016eeb166d92effbc1b2e0da"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab424b2b5016eeb166d92effbc1b2e0da">◆ </a></span>H5Rget_type()</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 H5Rget_type </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref_ptr</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, 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>H5Rget_type retrieves the type of a reference.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a valid reference type if successful; otherwise returns H5R UNKNOWN.</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>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gabca49bfdf0111ba8e272e169ece85049"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabca49bfdf0111ba8e272e169ece85049">◆ </a></span>H5Ropen_attr()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Ropen_attr </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>rapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>aapl_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, 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>H5Ropen_attr opens the attribute attached to the object and returns an identifier. The attribute opened with this function should be closed with H5Aclose when it is no longer needed so that resource leaks will not develop.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object. </td></tr> + <tr><td class="paramname">rapl_id</td><td>IN: A reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list). </td></tr> + <tr><td class="paramname">aapl_id</td><td>IN: An attribute access property list identifier for the reference. The access property property list must be of the same type as the object being referenced, that is a group or dataset property list.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a valid attribute identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gad8f49dcf2c74cd4320898f131414fcef"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad8f49dcf2c74cd4320898f131414fcef">◆ </a></span>H5Ropen_object()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Ropen_object </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>rapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>oapl_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, 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>H5Ropen_object opens that object and returns an identifier. The object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. Use the appropriate close function such as H5Oclose or H5Dclose for datasets.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object. </td></tr> + <tr><td class="paramname">rapl_id</td><td>IN: A reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list). </td></tr> + <tr><td class="paramname">oapl_id</td><td>IN: An object access property list identifier for the reference. The access property property list must be of the same type as the object being referenced, that is a group or dataset property list.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a valid identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9813a791d5650c6ee494c79cd15ac717"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9813a791d5650c6ee494c79cd15ac717">◆ </a></span>H5Ropen_region()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Ropen_region </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>ref_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>rapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>oapl_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, 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>H5Ropen region creates a copy of the dataspace of the dataset pointed to by a region reference, ref ptr, and defines a selection matching the selection pointed to by ref ptr within the dataspace copy. Use H5Sclose to release the dataspace identifier returned by this function when the identifier is no longer needed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ref_ptr</td><td>IN: Reference to an object, region or attribute attached to an object. </td></tr> + <tr><td class="paramname">rapl_id</td><td>IN: A reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list). </td></tr> + <tr><td class="paramname">oapl_id</td><td>IN: An object access property list identifier for the reference. The access property property list must be of the same type as the object being referenced, that is a group or dataset property list.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a valid dataspace identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </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> |