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_i.html | |
| parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
| download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 | |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'group___j_h5_i.html')
| -rw-r--r-- | group___j_h5_i.html | 785 |
1 files changed, 785 insertions, 0 deletions
diff --git a/group___j_h5_i.html b/group___j_h5_i.html new file mode 100644 index 0000000..9b83815 --- /dev/null +++ b/group___j_h5_i.html @@ -0,0 +1,785 @@ +<!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 Identifier (H5I) 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_i.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 Identifier (H5I) 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_i.html">Identifiers (H5I)</a>, C-API</dd> +<dd> +<a class="el" href="_h5_i__u_g.html">The HDF5 Identifiers</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:ga67c3b711ada908ec1c7f74c2c4c63b34"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#ga67c3b711ada908ec1c7f74c2c4c63b34">H5Iget_file_id</a> (long obj_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga67c3b711ada908ec1c7f74c2c4c63b34"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa4ad4819f0a2d36cfdb0738fcb7e0d3a"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#gaa4ad4819f0a2d36cfdb0738fcb7e0d3a">H5Iget_name_long</a> (long obj_id, String[] name, long size) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gaa4ad4819f0a2d36cfdb0738fcb7e0d3a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga45f322a460d35782efbe953c26ef8b42"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#ga45f322a460d35782efbe953c26ef8b42">H5Iget_name</a> (long obj_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga45f322a460d35782efbe953c26ef8b42"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae3266f3eb24f0accc39886d6acd91122"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#gae3266f3eb24f0accc39886d6acd91122">H5Iget_ref</a> (long obj_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gae3266f3eb24f0accc39886d6acd91122"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga00c0de46342f28a645d8157a421519fd"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#ga00c0de46342f28a645d8157a421519fd">H5Idec_ref</a> (long obj_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga00c0de46342f28a645d8157a421519fd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab058bd7352fb2f04cba8537b58afbfb4"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#gab058bd7352fb2f04cba8537b58afbfb4">H5Iinc_ref</a> (long obj_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gab058bd7352fb2f04cba8537b58afbfb4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4033155681a0fb02e0c0a3cec07d6356"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#ga4033155681a0fb02e0c0a3cec07d6356">H5Iget_type</a> (long obj_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga4033155681a0fb02e0c0a3cec07d6356"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaeeaa9dd8be62b560f40edcdc4459af9"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#gaaeeaa9dd8be62b560f40edcdc4459af9">H5Iget_type_ref</a> (long type_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gaaeeaa9dd8be62b560f40edcdc4459af9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7d17baeaace1bb60e049653767710570"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#ga7d17baeaace1bb60e049653767710570">H5Idec_type_ref</a> (long type_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga7d17baeaace1bb60e049653767710570"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7ac51458aee9db72ef0849b77a0751a5"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#ga7ac51458aee9db72ef0849b77a0751a5">H5Iinc_type_ref</a> (long type_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga7ac51458aee9db72ef0849b77a0751a5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae9737155634b7efb94ace586b6ad32e8"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#gae9737155634b7efb94ace586b6ad32e8">H5Inmembers</a> (long type_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gae9737155634b7efb94ace586b6ad32e8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6d6984bf8cbf9b3510142ef9935afd34"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#ga6d6984bf8cbf9b3510142ef9935afd34">H5Iis_valid</a> (long obj_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga6d6984bf8cbf9b3510142ef9935afd34"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0dc12f931cb6817fd1e4686860678d5f"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#ga0dc12f931cb6817fd1e4686860678d5f">H5Itype_exists</a> (int type_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga0dc12f931cb6817fd1e4686860678d5f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae13a9741d68a6270988692d059ef4ca2"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#gae13a9741d68a6270988692d059ef4ca2">H5Iclear_type</a> (int type_id, boolean force) throws HDF5LibraryException</td></tr> +<tr class="separator:gae13a9741d68a6270988692d059ef4ca2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4489be61cb7e5de21be86a859afa5263"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_i.html#ga4489be61cb7e5de21be86a859afa5263">H5Idestroy_type</a> (int type_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga4489be61cb7e5de21be86a859afa5263"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="gae13a9741d68a6270988692d059ef4ca2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae13a9741d68a6270988692d059ef4ca2">◆ </a></span>H5Iclear_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 void H5Iclear_type </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>force</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>H5Iclear_type deletes all identifiers of the type identified by the argument type.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type_id</td><td>IN: Identifier of identifier type which is to be cleared of identifiers </td></tr> + <tr><td class="paramname">force</td><td>IN: Whether or not to force deletion of all identifiers</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="ga00c0de46342f28a645d8157a421519fd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga00c0de46342f28a645d8157a421519fd">◆ </a></span>H5Idec_ref()</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 H5Idec_ref </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>, 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>H5Idec_ref decrements the reference count specified by the identifier, obj_id. If the reference count for an ID reaches zero, the object will be closed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the reference count.</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="ga7d17baeaace1bb60e049653767710570"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7d17baeaace1bb60e049653767710570">◆ </a></span>H5Idec_type_ref()</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 H5Idec_type_ref </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>type_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>H5Idec_type_ref decrements the reference count on an identifier type. The reference count is used by the library to indicate when an identifier type can be destroyed. If the reference count reaches zero, this function will destroy it.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type_id</td><td>IN: The identifier of the type whose reference count is to be decremented</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The current reference count on success, negative on failure.</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="ga4489be61cb7e5de21be86a859afa5263"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4489be61cb7e5de21be86a859afa5263">◆ </a></span>H5Idestroy_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 void H5Idestroy_type </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>type_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>H5Idestroy_type deletes an entire identifier type. All identifiers of this type are destroyed and no new identifiers of this type can be registered.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type_id</td><td>IN: Identifier of identifier type which is to be destroyed</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="ga67c3b711ada908ec1c7f74c2c4c63b34"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga67c3b711ada908ec1c7f74c2c4c63b34">◆ </a></span>H5Iget_file_id()</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 H5Iget_file_id </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Iget_file_id obtains the file ID specified by the identifier, obj_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the file ID.</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="ga45f322a460d35782efbe953c26ef8b42"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga45f322a460d35782efbe953c26ef8b42">◆ </a></span>H5Iget_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 H5Iget_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Iget_name retrieves the name of an object specified by the identifier, obj_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>String for Attribute name.</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="gaa4ad4819f0a2d36cfdb0738fcb7e0d3a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa4ad4819f0a2d36cfdb0738fcb7e0d3a">◆ </a></span>H5Iget_name_long()</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 H5Iget_name_long </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>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</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>H5Iget_name_long retrieves the name of an object specified by the identifier, obj_id. </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd></dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object. </td></tr> + <tr><td class="paramname">name</td><td>OUT: Attribute name buffer. </td></tr> + <tr><td class="paramname">size</td><td>IN: Maximum length of the name to retrieve.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the length of the name retrieved.</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="gae3266f3eb24f0accc39886d6acd91122"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae3266f3eb24f0accc39886d6acd91122">◆ </a></span>H5Iget_ref()</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 H5Iget_ref </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>, 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>H5Iget_ref obtains the number of references outstanding specified by the identifier, obj_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the reference count.</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="ga4033155681a0fb02e0c0a3cec07d6356"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4033155681a0fb02e0c0a3cec07d6356">◆ </a></span>H5Iget_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 H5Iget_type </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Iget_type retrieves the type of the object identified by obj_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Object identifier whose type is to be determined.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the object type if successful; otherwise H5I_BADID.</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="gaaeeaa9dd8be62b560f40edcdc4459af9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaaeeaa9dd8be62b560f40edcdc4459af9">◆ </a></span>H5Iget_type_ref()</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 H5Iget_type_ref </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>type_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>H5Iget_type_ref retrieves the reference count on an ID type. The reference count is used by the library to indicate when an ID type can be destroyed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type_id</td><td>IN: The identifier of the type whose reference count is to be retrieved</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The current reference count on success, negative on failure.</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="gab058bd7352fb2f04cba8537b58afbfb4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab058bd7352fb2f04cba8537b58afbfb4">◆ </a></span>H5Iinc_ref()</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 H5Iinc_ref </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>, 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>H5Iinc_ref increments the reference count specified by the identifier, obj_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the reference count.</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="ga7ac51458aee9db72ef0849b77a0751a5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7ac51458aee9db72ef0849b77a0751a5">◆ </a></span>H5Iinc_type_ref()</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 H5Iinc_type_ref </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>type_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>H5Iinc_type_ref increments the reference count on an ID type. The reference count is used by the library to indicate when an ID type can be destroyed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type_id</td><td>IN: The identifier of the type whose reference count is to be incremented</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The current reference count on success, negative on failure.</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="ga6d6984bf8cbf9b3510142ef9935afd34"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga6d6984bf8cbf9b3510142ef9935afd34">◆ </a></span>H5Iis_valid()</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 H5Iis_valid </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Iis_valid indicates if the identifier type specified in obj_id is valid.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier to be checked</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a boolean, true if the specified identifier id is valid</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="gae9737155634b7efb94ace586b6ad32e8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae9737155634b7efb94ace586b6ad32e8">◆ </a></span>H5Inmembers()</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 H5Inmembers </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>type_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>H5Inmembers returns the number of identifiers of the identifier type specified in type.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type_id</td><td>IN: Identifier for the identifier type whose member count will be retrieved</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Number of identifiers of the specified identifier 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> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0dc12f931cb6817fd1e4686860678d5f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0dc12f931cb6817fd1e4686860678d5f">◆ </a></span>H5Itype_exists()</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 H5Itype_exists </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>type_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>H5Itype_exists indicates if the identifier type specified in type exists.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type_id</td><td>IN: the identifier type to be checked</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a boolean, true if the specified identifier type exists</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated on Mon Jun 26 2023 19:01:38 for HDF5 by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + </ul> +</div> +</body> +</html> |