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_a.html | |
| parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
| download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 | |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'group___j_h5_a.html')
| -rw-r--r-- | group___j_h5_a.html | 3979 |
1 files changed, 3979 insertions, 0 deletions
diff --git a/group___j_h5_a.html b/group___j_h5_a.html new file mode 100644 index 0000000..0aee536 --- /dev/null +++ b/group___j_h5_a.html @@ -0,0 +1,3979 @@ +<!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 Attribute (H5A) 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_a.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 Attribute (H5A) Interface</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>An HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. A primary data object may be a dataset, group, or committed datatype.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_a.html">Attributes (H5A)</a>, C-API</dd> +<dd> +<a class="el" href="_h5_a__u_g.html">HDF5 Attributes</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:ga61a9266c4d56c7cab986f388fccec12d"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga61a9266c4d56c7cab986f388fccec12d">H5Aclose</a> (long attr_id) throws HDF5LibraryException </td></tr> +<tr class="separator:ga61a9266c4d56c7cab986f388fccec12d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga15e2ddc26358dd575d05a2205657929b"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga15e2ddc26358dd575d05a2205657929b">H5Acopy</a> (long src_aid, long dst_aid) throws HDF5LibraryException</td></tr> +<tr class="separator:ga15e2ddc26358dd575d05a2205657929b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga25bcea7db0b78e465d30a696dbdce622"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga25bcea7db0b78e465d30a696dbdce622">H5Acreate</a> (long loc_id, String attr_name, long type_id, long space_id, long acpl_id, long aapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga25bcea7db0b78e465d30a696dbdce622"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaef64fc50a8e431d7ef2a408c0b7f182"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gaaef64fc50a8e431d7ef2a408c0b7f182">H5Acreate_by_name</a> (long loc_id, String obj_name, String attr_name, long type_id, long space_id, long acpl_id, long aapl_id, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gaaef64fc50a8e431d7ef2a408c0b7f182"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1b9cf352d8c13cf44100994b7f0ba59a"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga1b9cf352d8c13cf44100994b7f0ba59a">H5Adelete</a> (long loc_id, String name) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga1b9cf352d8c13cf44100994b7f0ba59a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf3dce5df66e9755bc7fc7f48227173e5"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gaf3dce5df66e9755bc7fc7f48227173e5">H5Adelete_by_idx</a> (long loc_id, String obj_name, int idx_type, int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gaf3dce5df66e9755bc7fc7f48227173e5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1c93e03fe90ded2036fdef54b5ac11b4"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga1c93e03fe90ded2036fdef54b5ac11b4">H5Adelete_by_name</a> (long loc_id, String obj_name, String attr_name, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga1c93e03fe90ded2036fdef54b5ac11b4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9acefc248d57f22eb413edb32a06ca75"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga9acefc248d57f22eb413edb32a06ca75">H5Aexists</a> (long obj_id, String attr_name) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga9acefc248d57f22eb413edb32a06ca75"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga93541205dbc0260716beb3aff646e2da"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga93541205dbc0260716beb3aff646e2da">H5Aexists_by_name</a> (long loc_id, String obj_name, String attr_name, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga93541205dbc0260716beb3aff646e2da"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga92a7fbfeecd1aee296bc00b85c9b1c87"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_a__info__t.html">H5A_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga92a7fbfeecd1aee296bc00b85c9b1c87">H5Aget_info</a> (long attr_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga92a7fbfeecd1aee296bc00b85c9b1c87"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac792c8bff4ffe01fff14e426e8ba5750"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_a__info__t.html">H5A_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gac792c8bff4ffe01fff14e426e8ba5750">H5Aget_info_by_idx</a> (long loc_id, String obj_name, int idx_type, int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gac792c8bff4ffe01fff14e426e8ba5750"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadc8d9180ef0d236b8cd741fca63141f2"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_a__info__t.html">H5A_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gadc8d9180ef0d236b8cd741fca63141f2">H5Aget_info_by_name</a> (long loc_id, String obj_name, String attr_name, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gadc8d9180ef0d236b8cd741fca63141f2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga649bd84dc46315fbfd1b6938b2779ac2"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga649bd84dc46315fbfd1b6938b2779ac2">H5Aget_name</a> (long attr_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga649bd84dc46315fbfd1b6938b2779ac2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab29ca740020bf84b4a6d4d18799e06b5"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gab29ca740020bf84b4a6d4d18799e06b5">H5Aget_name_by_idx</a> (long attr_id, String obj_name, int idx_type, int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gab29ca740020bf84b4a6d4d18799e06b5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0dadc193362d0aaab3391c7d3f731f9f"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga0dadc193362d0aaab3391c7d3f731f9f">H5Aget_space</a> (long attr_id) throws HDF5LibraryException </td></tr> +<tr class="separator:ga0dadc193362d0aaab3391c7d3f731f9f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac3e3a85e7243114990595d67c05d9c62"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gac3e3a85e7243114990595d67c05d9c62">H5Aget_storage_size</a> (long attr_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gac3e3a85e7243114990595d67c05d9c62"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaf198a98579bdf13a608b8c0039f85a1"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gaaf198a98579bdf13a608b8c0039f85a1">H5Aget_type</a> (long attr_id) throws HDF5LibraryException </td></tr> +<tr class="separator:gaaf198a98579bdf13a608b8c0039f85a1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab03fbbac9f1d0d57c6c3f327b14495e0"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gab03fbbac9f1d0d57c6c3f327b14495e0">H5Aopen</a> (long obj_id, String attr_name, long aapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gab03fbbac9f1d0d57c6c3f327b14495e0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab77c909b06d05667592a86f328d80658"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gab77c909b06d05667592a86f328d80658">H5Aopen_by_idx</a> (long loc_id, String obj_name, int idx_type, int order, long n, long aapl_id, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gab77c909b06d05667592a86f328d80658"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5cdc96a75590fe051993ddd33c493261"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga5cdc96a75590fe051993ddd33c493261">H5Aopen_by_name</a> (long loc_id, String obj_name, String attr_name, long aapl_id, long lapl_id) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga5cdc96a75590fe051993ddd33c493261"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga50aa18c0a4888aca036352c295bb3c53"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga50aa18c0a4888aca036352c295bb3c53">H5Aread</a> (long attr_id, long mem_type_id, byte[] obj, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga50aa18c0a4888aca036352c295bb3c53"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa44b6f86836fed030cc1319e77c23d7f"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gaa44b6f86836fed030cc1319e77c23d7f">H5Aread</a> (long attr_id, long mem_type_id, byte[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gaa44b6f86836fed030cc1319e77c23d7f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga267be864f446fc9b37ac44fd0eab80f4"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga267be864f446fc9b37ac44fd0eab80f4">H5Aread</a> (long attr_id, long mem_type_id, Object obj) throws HDF5Exception, HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga267be864f446fc9b37ac44fd0eab80f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9df8e4145de9dba1e1ca9e044d225881"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga9df8e4145de9dba1e1ca9e044d225881">H5Aread</a> (long attr_id, long mem_type_id, Object obj, boolean isCriticalPinning) throws HDF5Exception, HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga9df8e4145de9dba1e1ca9e044d225881"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga065d477ff06d2e85e359aa5a799c73c2"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga065d477ff06d2e85e359aa5a799c73c2">H5Aread_double</a> (long attr_id, long mem_type_id, double[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga065d477ff06d2e85e359aa5a799c73c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7e6a869274e82c06e168706ef9ee45c6"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga7e6a869274e82c06e168706ef9ee45c6">H5Aread_double</a> (long attr_id, long mem_type_id, double[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga7e6a869274e82c06e168706ef9ee45c6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0b447a9c4034c1c4890b9e6a97eac419"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga0b447a9c4034c1c4890b9e6a97eac419">H5Aread_float</a> (long attr_id, long mem_type_id, float[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga0b447a9c4034c1c4890b9e6a97eac419"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga96ee408c73c103cf73b0f105a9a3d1f2"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga96ee408c73c103cf73b0f105a9a3d1f2">H5Aread_int</a> (long attr_id, long mem_type_id, int[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga96ee408c73c103cf73b0f105a9a3d1f2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga87be8f492b055044162ca8e014a53f08"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga87be8f492b055044162ca8e014a53f08">H5Aread_int</a> (long attr_id, long mem_type_id, int[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga87be8f492b055044162ca8e014a53f08"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaad26555c18b243c7fdc9a07c95bdd837"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gaad26555c18b243c7fdc9a07c95bdd837">H5Aread_long</a> (long attr_id, long mem_type_id, long[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gaad26555c18b243c7fdc9a07c95bdd837"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9d2796ab2d8a6b4a591dad95aec6b6e8"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga9d2796ab2d8a6b4a591dad95aec6b6e8">H5Aread_long</a> (long attr_id, long mem_type_id, long[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga9d2796ab2d8a6b4a591dad95aec6b6e8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4db0af648768ad62e3a9b07042c6f03a"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga4db0af648768ad62e3a9b07042c6f03a">H5Aread_reg_ref</a> (long attr_id, long mem_type_id, String[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga4db0af648768ad62e3a9b07042c6f03a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga50304671318d0efb6fb8866dae0e996f"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga50304671318d0efb6fb8866dae0e996f">H5Aread_short</a> (long attr_id, long mem_type_id, short[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga50304671318d0efb6fb8866dae0e996f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3b2d5aee7e72b8fbb3b623ae75352949"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga3b2d5aee7e72b8fbb3b623ae75352949">H5Aread_short</a> (long attr_id, long mem_type_id, short[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga3b2d5aee7e72b8fbb3b623ae75352949"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad04754c268aa66ca3b8c18110e1c3c6c"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gad04754c268aa66ca3b8c18110e1c3c6c">H5AreadVL</a> (long attr_id, long mem_type_id, Object[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gad04754c268aa66ca3b8c18110e1c3c6c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga116bd59812a29614df2fd3c77c345453"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga116bd59812a29614df2fd3c77c345453">H5Aread_string</a> (long attr_id, long mem_type_id, String[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga116bd59812a29614df2fd3c77c345453"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2e111a59e6f121e96f2177f9827a9a76"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga2e111a59e6f121e96f2177f9827a9a76">H5Aread_VLStrings</a> (long attr_id, long mem_type_id, Object[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga2e111a59e6f121e96f2177f9827a9a76"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1668084bf9c3d9d1cf1853941612549d"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga1668084bf9c3d9d1cf1853941612549d">H5AreadComplex</a> (long attr_id, long mem_type_id, String[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga1668084bf9c3d9d1cf1853941612549d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7d8a79d52248bdb0c3ccce213682c3cc"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga7d8a79d52248bdb0c3ccce213682c3cc">H5Arename</a> (long loc_id, String old_attr_name, String new_attr_name) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga7d8a79d52248bdb0c3ccce213682c3cc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3643633f5b07620ec3f0a91f87845fba"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga3643633f5b07620ec3f0a91f87845fba">H5Arename_by_name</a> (long loc_id, String obj_name, String old_attr_name, String new_attr_name, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga3643633f5b07620ec3f0a91f87845fba"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7ffe09818ce28adde61601f8eca4b98b"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga7ffe09818ce28adde61601f8eca4b98b">H5Awrite</a> (long attr_id, long mem_type_id, byte[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga7ffe09818ce28adde61601f8eca4b98b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga54c06473da6ec647147a5d36cb532b2b"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga54c06473da6ec647147a5d36cb532b2b">H5Awrite</a> (long attr_id, long mem_type_id, byte[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga54c06473da6ec647147a5d36cb532b2b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadc25ad6e54478ced9a6c8b5a90a38502"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gadc25ad6e54478ced9a6c8b5a90a38502">H5Awrite</a> (long attr_id, long mem_type_id, Object obj) throws HDF5Exception, HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gadc25ad6e54478ced9a6c8b5a90a38502"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaf7d64c744618212952ff6aa0475aa65"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gaaf7d64c744618212952ff6aa0475aa65">H5Awrite</a> (long attr_id, long mem_type_id, Object obj, boolean isCriticalPinning) throws HDF5Exception, HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gaaf7d64c744618212952ff6aa0475aa65"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2cfb8294a0e63bdd995a1f08b550cc8c"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga2cfb8294a0e63bdd995a1f08b550cc8c">H5Awrite_double</a> (long attr_id, long mem_type_id, double[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga2cfb8294a0e63bdd995a1f08b550cc8c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga24140794434a0e37a8f904824696fa27"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga24140794434a0e37a8f904824696fa27">H5Awrite_double</a> (long attr_id, long mem_type_id, double[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga24140794434a0e37a8f904824696fa27"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad01a334aa1d989fce739be069109b6b6"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gad01a334aa1d989fce739be069109b6b6">H5Awrite_float</a> (long attr_id, long mem_type_id, float[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gad01a334aa1d989fce739be069109b6b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa5df34930852dbedf33451861a6535f7"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gaa5df34930852dbedf33451861a6535f7">H5Awrite_float</a> (long attr_id, long mem_type_id, float[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gaa5df34930852dbedf33451861a6535f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf2747a62d729e6f464b89d27f3e513f1"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gaf2747a62d729e6f464b89d27f3e513f1">H5Awrite_int</a> (long attr_id, long mem_type_id, int[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gaf2747a62d729e6f464b89d27f3e513f1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga19b87f17c6d5e6ddd6733390e3a43c5e"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga19b87f17c6d5e6ddd6733390e3a43c5e">H5Awrite_int</a> (long attr_id, long mem_type_id, int[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga19b87f17c6d5e6ddd6733390e3a43c5e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabc4ce2ad7044f6105e2c4b5d397559fa"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gabc4ce2ad7044f6105e2c4b5d397559fa">H5Awrite_long</a> (long attr_id, long mem_type_id, long[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gabc4ce2ad7044f6105e2c4b5d397559fa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga81b3d894b91daa0b72ecd8f8f03623a5"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga81b3d894b91daa0b72ecd8f8f03623a5">H5Awrite_long</a> (long attr_id, long mem_type_id, long[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:ga81b3d894b91daa0b72ecd8f8f03623a5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga41f45d3867ee38da211f7c593ab07ebb"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga41f45d3867ee38da211f7c593ab07ebb">H5Awrite_short</a> (long attr_id, long mem_type_id, short[] buf, boolean isCriticalPinning) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga41f45d3867ee38da211f7c593ab07ebb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab5fc756b54a8c4ccd824b4a2df4ae71b"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gab5fc756b54a8c4ccd824b4a2df4ae71b">H5Awrite_short</a> (long attr_id, long mem_type_id, short[] buf) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gab5fc756b54a8c4ccd824b4a2df4ae71b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaeb7be2cda75ecbb92d5e45b2fa3239d7"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gaeb7be2cda75ecbb92d5e45b2fa3239d7">H5Awrite_string</a> (long attr_id, long mem_type_id, String[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gaeb7be2cda75ecbb92d5e45b2fa3239d7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga31fe569cd880bfd57fbd77ab2fee7654"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga31fe569cd880bfd57fbd77ab2fee7654">H5AwriteVL</a> (long attr_id, long mem_type_id, Object[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga31fe569cd880bfd57fbd77ab2fee7654"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gada48a09474de16493bad95d2d65280a1"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#gada48a09474de16493bad95d2d65280a1">H5Awrite_VLStrings</a> (long attr_id, long mem_type_id, Object[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gada48a09474de16493bad95d2d65280a1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga095c98b0d045b20ec0fd80373cff6568"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga095c98b0d045b20ec0fd80373cff6568">H5Aget_create_plist</a> (long attr_id) throws HDF5LibraryException </td></tr> +<tr class="separator:ga095c98b0d045b20ec0fd80373cff6568"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga75ccd94181cd920dbab3ce0420a94b12"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga75ccd94181cd920dbab3ce0420a94b12">H5Aiterate</a> (long loc_id, int idx_type, int order, long idx, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html">H5A_iterate_cb</a> op, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__t.html">H5A_iterate_t</a> op_data) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga75ccd94181cd920dbab3ce0420a94b12"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0800fa298fc12d1f74f0eed0c9c26b6b"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_a.html#ga0800fa298fc12d1f74f0eed0c9c26b6b">H5Aiterate_by_name</a> (long loc_id, String obj_name, int idx_type, int order, long idx, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html">H5A_iterate_cb</a> op, <a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__t.html">H5A_iterate_t</a> op_data, long lapl_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga0800fa298fc12d1f74f0eed0c9c26b6b"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="ga61a9266c4d56c7cab986f388fccec12d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga61a9266c4d56c7cab986f388fccec12d">◆ </a></span>H5Aclose()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int H5Aclose </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_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>H5Aclose terminates access to the attribute specified by its identifier, attr_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Attribute to release access to.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga15e2ddc26358dd575d05a2205657929b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga15e2ddc26358dd575d05a2205657929b">◆ </a></span>H5Acopy()</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 H5Acopy </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>src_aid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>dst_aid</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>H5Acopy copies the content of one attribute to another.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">src_aid</td><td>the identifier of the source attribute </td></tr> + <tr><td class="paramname">dst_aid</td><td>the identifier of the destination attribute</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga25bcea7db0b78e465d30a696dbdce622"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga25bcea7db0b78e465d30a696dbdce622">◆ </a></span>H5Acreate()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Acreate </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>attr_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>type_id</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>acpl_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</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>H5Acreate creates an attribute, attr_name, which is attached to the object specified by the identifier loc_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location or object identifier; may be dataset or group </td></tr> + <tr><td class="paramname">attr_name</td><td>IN: Attribute name </td></tr> + <tr><td class="paramname">type_id</td><td>IN: Attribute datatype identifier </td></tr> + <tr><td class="paramname">space_id</td><td>IN: Attribute dataspace identifier </td></tr> + <tr><td class="paramname">acpl_id</td><td>IN: Attribute creation property list identifier </td></tr> + <tr><td class="paramname">aapl_id</td><td>IN: Attribute access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>An attribute identifier if successful; 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>Name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaaef64fc50a8e431d7ef2a408c0b7f182"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaaef64fc50a8e431d7ef2a408c0b7f182">◆ </a></span>H5Acreate_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Acreate_by_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">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>type_id</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>acpl_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 class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Acreate_by_name creates an attribute, attr_name, which is attached to the object specified by loc_id and obj_name.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location or object identifier; may be dataset or group </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name, relative to loc_id, of object that attribute is to be attached to </td></tr> + <tr><td class="paramname">attr_name</td><td>IN: Attribute name </td></tr> + <tr><td class="paramname">type_id</td><td>IN: Attribute datatype identifier </td></tr> + <tr><td class="paramname">space_id</td><td>IN: Attribute dataspace identifier </td></tr> + <tr><td class="paramname">acpl_id</td><td>IN: Attribute creation property list identifier (currently not used). </td></tr> + <tr><td class="paramname">aapl_id</td><td>IN: Attribute access property list identifier (currently not used). </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>An attribute identifier if successful; 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>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga1b9cf352d8c13cf44100994b7f0ba59a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1b9cf352d8c13cf44100994b7f0ba59a">◆ </a></span>H5Adelete()</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 H5Adelete </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Adelete removes the attribute specified by its name, name, from a dataset, group, or named datatype.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier of the dataset, group, or named datatype. </td></tr> + <tr><td class="paramname">name</td><td>IN: Name of the attribute to delete.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaf3dce5df66e9755bc7fc7f48227173e5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf3dce5df66e9755bc7fc7f48227173e5">◆ </a></span>H5Adelete_by_idx()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Adelete_by_idx </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>order</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>n</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Adelete_by_idx removes an attribute, specified by its location in an index, from an object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location or object identifier; may be dataset or group </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name of object, relative to location, from which attribute is to be removed </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: Type of index </td></tr> + <tr><td class="paramname">order</td><td>IN: Order in which to iterate over index </td></tr> + <tr><td class="paramname">n</td><td>IN: Offset within index </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>obj_name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga1c93e03fe90ded2036fdef54b5ac11b4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1c93e03fe90ded2036fdef54b5ac11b4">◆ </a></span>H5Adelete_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Adelete_by_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">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>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Adelete_by_name removes the attribute attr_name from an object specified by location and name, loc_id and obj_name, respectively.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location or object identifier; may be dataset or group </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name of object, relative to location, from which attribute is to be removed </td></tr> + <tr><td class="paramname">attr_name</td><td>IN: Name of attribute to delete </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list identifier.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful; 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>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9acefc248d57f22eb413edb32a06ca75"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9acefc248d57f22eb413edb32a06ca75">◆ </a></span>H5Aexists()</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 H5Aexists </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>attr_name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Aexists determines whether the attribute attr_name exists on the object specified 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. </td></tr> + <tr><td class="paramname">attr_name</td><td>IN: Name of the attribute.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>boolean true if an attribute with a given name 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> + <tr><td class="paramname">NullPointerException</td><td>attr_name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga93541205dbc0260716beb3aff646e2da"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga93541205dbc0260716beb3aff646e2da">◆ </a></span>H5Aexists_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Aexists_by_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">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>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Aexists_by_name determines whether the attribute attr_name exists on an object. That object is specified by its location and name, loc_id and obj_name, respectively.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location of object to which attribute is attached . </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name, relative to loc_id, of object that attribute is attached to. </td></tr> + <tr><td class="paramname">attr_name</td><td>IN: Name of attribute. </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list identifier.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>boolean true if an attribute with a given name exists, otherwise returns 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>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga095c98b0d045b20ec0fd80373cff6568"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga095c98b0d045b20ec0fd80373cff6568">◆ </a></span>H5Aget_create_plist()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Aget_create_plist </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_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>H5Aget_create_plist retrieves a copy of the attribute creation property list identifier.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>identifier for the attribute's creation property list if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga92a7fbfeecd1aee296bc00b85c9b1c87"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga92a7fbfeecd1aee296bc00b85c9b1c87">◆ </a></span>H5Aget_info()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_a__info__t.html">H5A_info_t</a> H5Aget_info </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_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>H5Aget_info retrieves attribute information, by attribute identifier.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Attribute identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A buffer(H5A_info_t) for Attribute information</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac792c8bff4ffe01fff14e426e8ba5750"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac792c8bff4ffe01fff14e426e8ba5750">◆ </a></span>H5Aget_info_by_idx()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_a__info__t.html">H5A_info_t</a> H5Aget_info_by_idx </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>order</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>n</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Aget_info_by_idx Retrieves attribute information, by attribute index position.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location of object to which attribute is attached </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name of object to which attribute is attached, relative to location </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: Type of index </td></tr> + <tr><td class="paramname">order</td><td>IN: Index traversal order </td></tr> + <tr><td class="paramname">n</td><td>IN: Attribute's position in index </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A buffer(H5A_info_t) for Attribute information</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>obj_name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gadc8d9180ef0d236b8cd741fca63141f2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadc8d9180ef0d236b8cd741fca63141f2">◆ </a></span>H5Aget_info_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_a__info__t.html">H5A_info_t</a> H5Aget_info_by_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_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>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Aget_info_by_name Retrieves attribute information, by attribute name.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location of object to which attribute is attached </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name of object to which attribute is attached, relative to location </td></tr> + <tr><td class="paramname">attr_name</td><td>IN: Attribute name </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A buffer(H5A_info_t) for Attribute information</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>obj_name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga649bd84dc46315fbfd1b6938b2779ac2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga649bd84dc46315fbfd1b6938b2779ac2">◆ </a></span>H5Aget_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 H5Aget_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_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>H5Aget_name retrieves the name of an attribute specified by the identifier, attr_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of the attribute.</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="gab29ca740020bf84b4a6d4d18799e06b5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab29ca740020bf84b4a6d4d18799e06b5">◆ </a></span>H5Aget_name_by_idx()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native String H5Aget_name_by_idx </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>order</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>n</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Aget_name_by_idx retrieves the name of an attribute that is attached to an object, which is specified by its location and name, loc_id and obj_name, respectively.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Attribute identifier </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name of object to which attribute is attached, relative to location </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: Type of index </td></tr> + <tr><td class="paramname">order</td><td>IN: Index traversal order </td></tr> + <tr><td class="paramname">n</td><td>IN: Attribute's position in index </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>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> + <tr><td class="paramname">NullPointerException</td><td>obj_name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0dadc193362d0aaab3391c7d3f731f9f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0dadc193362d0aaab3391c7d3f731f9f">◆ </a></span>H5Aget_space()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Aget_space </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_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>H5Aget_space retrieves a copy of the dataspace for an attribute.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>attribute 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> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac3e3a85e7243114990595d67c05d9c62"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac3e3a85e7243114990595d67c05d9c62">◆ </a></span>H5Aget_storage_size()</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 H5Aget_storage_size </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_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>H5Aget_storage_size returns the amount of storage that is required for the specified attribute, attr_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of the attribute to query.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the amount of storage size allocated for the attribute; otherwise returns 0 (zero)</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaaf198a98579bdf13a608b8c0039f85a1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaaf198a98579bdf13a608b8c0039f85a1">◆ </a></span>H5Aget_type()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Aget_type </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_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>H5Aget_type retrieves a copy of the datatype for an attribute.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a datatype 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> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga75ccd94181cd920dbab3ce0420a94b12"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga75ccd94181cd920dbab3ce0420a94b12">◆ </a></span>H5Aiterate()</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 H5Aiterate </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>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>order</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html">H5A_iterate_cb</a> </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__t.html">H5A_iterate_t</a> </td> + <td class="paramname"><em>op_data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Aiterate2 iterates over the attributes attached to a dataset, named datatype, or group, as specified by obj_id. For each attribute, user-provided data, op_data, with additional information as defined below, is passed to a user-defined function, op, which operates on that attribute.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier for object to which attributes are attached; may be group, dataset, or named datatype. </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: The type of index specified by idx_type can be one of the following: H5_INDEX_NAME An alphanumeric index by attribute name. H5_INDEX_CRT_ORDER An index by creation order. </td></tr> + <tr><td class="paramname">order</td><td>IN: The order in which the index is to be traversed, as specified by order, can be one of the following: H5_ITER_INC Iteration is from beginning to end, i.e., a top-down iteration incrementing the index position at each step. H5_ITER_DEC Iteration starts at the end of the index, i.e., a bottom-up iteration decrementing the index position at each step. H5_ITER_NATIVE HDF5 iterates in the fastest-available order. No information is provided as to the order, but HDF5 ensures that each element in the index will be visited if the iteration completes successfully. </td></tr> + <tr><td class="paramname">idx</td><td>IN/OUT: Initial and returned offset within index. </td></tr> + <tr><td class="paramname">op</td><td>IN: Callback function to operate on each value. </td></tr> + <tr><td class="paramname">op_data</td><td>IN/OUT: Pointer to any user-efined data for use by operator function.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>buf is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0800fa298fc12d1f74f0eed0c9c26b6b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0800fa298fc12d1f74f0eed0c9c26b6b">◆ </a></span>H5Aiterate_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Aiterate_by_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>order</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__cb.html">H5A_iterate_cb</a> </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="interfacehdf_1_1hdf5lib_1_1callbacks_1_1_h5_a__iterate__t.html">H5A_iterate_t</a> </td> + <td class="paramname"><em>op_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Aiterate_by_name iterates over the attributes attached to the dataset or group specified with loc_id and obj_name. For each attribute, user-provided data, op_data, with additional information as defined below, is passed to a user-defined function, op, which operates on that attribute.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Identifier for object to which attributes are attached; may be group, dataset, or named datatype. </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name of object, relative to location. </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: The type of index specified by idx_type can be one of the following: H5_INDEX_NAME An alphanumeric index by attribute name. H5_INDEX_CRT_ORDER An index by creation order. </td></tr> + <tr><td class="paramname">order</td><td>IN: The order in which the index is to be traversed, as specified by order, can be one of the following: H5_ITER_INC Iteration is from beginning to end, i.e., a top-down iteration incrementing the index position at each step. H5_ITER_DEC Iteration starts at the end of the index, i.e., a bottom-up iteration decrementing the index position at each step. H5_ITER_NATIVE HDF5 iterates in the fastest-available order. No information is provided as to the order, but HDF5 ensures that each element in the index will be visited if the iteration completes successfully. </td></tr> + <tr><td class="paramname">idx</td><td>IN/OUT: Initial and returned offset within index. </td></tr> + <tr><td class="paramname">op</td><td>IN: Callback function to operate on each value. </td></tr> + <tr><td class="paramname">op_data</td><td>IN/OUT: Pointer to any user-efined data for use by operator function. </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>buf is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gab03fbbac9f1d0d57c6c3f327b14495e0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab03fbbac9f1d0d57c6c3f327b14495e0">◆ </a></span>H5Aopen()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Aopen </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>attr_name</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</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>H5Aopen opens an existing attribute, attr_name, that is attached to an object specified an object identifier, object_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier for object to which attribute is attached </td></tr> + <tr><td class="paramname">attr_name</td><td>IN: Name of attribute to open </td></tr> + <tr><td class="paramname">aapl_id</td><td>IN: Attribute access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>An attribute identifier if successful; 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>Name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gab77c909b06d05667592a86f328d80658"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab77c909b06d05667592a86f328d80658">◆ </a></span>H5Aopen_by_idx()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Aopen_by_idx </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>idx_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>order</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>n</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>aapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Aopen_by_idx opens an existing attribute that is attached to an object specified by location and name, loc_id and obj_name, respectively</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location of object to which attribute is attached </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name of object to which attribute is attached, relative to location </td></tr> + <tr><td class="paramname">idx_type</td><td>IN: Type of index </td></tr> + <tr><td class="paramname">order</td><td>IN: Index traversal order </td></tr> + <tr><td class="paramname">n</td><td>IN: Attribute's position in index </td></tr> + <tr><td class="paramname">aapl_id</td><td>IN: Attribute access property list </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>An attribute identifier if successful; 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>Name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga5cdc96a75590fe051993ddd33c493261"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5cdc96a75590fe051993ddd33c493261">◆ </a></span>H5Aopen_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Aopen_by_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">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>aapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Aopen_by_name Opens an attribute for an object by object name and attribute name</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location from which to find object to which attribute is attached </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name of object to which attribute is attached, relative to loc_id </td></tr> + <tr><td class="paramname">attr_name</td><td>IN: Name of attribute to open </td></tr> + <tr><td class="paramname">aapl_id</td><td>IN: Attribute access property list </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns an attribute identifier if successful; 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>obj_name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaa44b6f86836fed030cc1319e77c23d7f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa44b6f86836fed030cc1319e77c23d7f">◆ </a></span>H5Aread() <span class="overload">[1/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Aread </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga50aa18c0a4888aca036352c295bb3c53"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga50aa18c0a4888aca036352c295bb3c53">◆ </a></span>H5Aread() <span class="overload">[2/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Aread </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>obj</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">obj</td><td>Buffer to store data read from the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga267be864f446fc9b37ac44fd0eab80f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga267be864f446fc9b37ac44fd0eab80f4">◆ </a></span>H5Aread() <span class="overload">[3/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Aread </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Object </td> + <td class="paramname"><em>obj</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_exception.html">HDF5Exception</a>, <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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">obj</td><td>Buffer to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9df8e4145de9dba1e1ca9e044d225881"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9df8e4145de9dba1e1ca9e044d225881">◆ </a></span>H5Aread() <span class="overload">[4/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Aread </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Object </td> + <td class="paramname"><em>obj</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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_exception.html">HDF5Exception</a>, <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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into data object from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">obj</td><td>IN: Object for data to be read. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5Exception</td><td>Failure in the data conversion. </td></tr> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. See public synchronized static native int <a class="el" href="group___j_h5_a.html#ga50aa18c0a4888aca036352c295bb3c53">H5Aread( )</a> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga7e6a869274e82c06e168706ef9ee45c6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7e6a869274e82c06e168706ef9ee45c6">◆ </a></span>H5Aread_double() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Aread_double </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of double from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of double to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga065d477ff06d2e85e359aa5a799c73c2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga065d477ff06d2e85e359aa5a799c73c2">◆ </a></span>H5Aread_double() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Aread_double </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of double from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of double to store data read from the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0b447a9c4034c1c4890b9e6a97eac419"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0b447a9c4034c1c4890b9e6a97eac419">◆ </a></span>H5Aread_float()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Aread_float </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of float from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of float to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga87be8f492b055044162ca8e014a53f08"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga87be8f492b055044162ca8e014a53f08">◆ </a></span>H5Aread_int() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Aread_int </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of int from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of int to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga96ee408c73c103cf73b0f105a9a3d1f2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga96ee408c73c103cf73b0f105a9a3d1f2">◆ </a></span>H5Aread_int() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Aread_int </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of int from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of int to store data read from the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9d2796ab2d8a6b4a591dad95aec6b6e8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9d2796ab2d8a6b4a591dad95aec6b6e8">◆ </a></span>H5Aread_long() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Aread_long </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of long from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of long to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaad26555c18b243c7fdc9a07c95bdd837"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaad26555c18b243c7fdc9a07c95bdd837">◆ </a></span>H5Aread_long() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Aread_long </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of long from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of long to store data read from the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga4db0af648768ad62e3a9b07042c6f03a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4db0af648768ad62e3a9b07042c6f03a">◆ </a></span>H5Aread_reg_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 H5Aread_reg_ref </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of String from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of String to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga3b2d5aee7e72b8fbb3b623ae75352949"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3b2d5aee7e72b8fbb3b623ae75352949">◆ </a></span>H5Aread_short() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Aread_short </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">short[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of shortfrom the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of short to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga50304671318d0efb6fb8866dae0e996f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga50304671318d0efb6fb8866dae0e996f">◆ </a></span>H5Aread_short() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Aread_short </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">short[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of short from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of short to store data read from the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga116bd59812a29614df2fd3c77c345453"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga116bd59812a29614df2fd3c77c345453">◆ </a></span>H5Aread_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 int H5Aread_string </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of String from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of String to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga2e111a59e6f121e96f2177f9827a9a76"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2e111a59e6f121e96f2177f9827a9a76">◆ </a></span>H5Aread_VLStrings()</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 H5Aread_VLStrings </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Object[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of variable-lenght strings from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of variable-lenght strings to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga1668084bf9c3d9d1cf1853941612549d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1668084bf9c3d9d1cf1853941612549d">◆ </a></span>H5AreadComplex()</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 H5AreadComplex </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of string from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of string to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gad04754c268aa66ca3b8c18110e1c3c6c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad04754c268aa66ca3b8c18110e1c3c6c">◆ </a></span>H5AreadVL()</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 H5AreadVL </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Object[] </td> + <td class="paramname"><em>buf</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>H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of variable-lenght from the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to read. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of variable-lenght to store data read from the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data buffer is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga7d8a79d52248bdb0c3ccce213682c3cc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7d8a79d52248bdb0c3ccce213682c3cc">◆ </a></span>H5Arename()</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 H5Arename </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>old_attr_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>new_attr_name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Arename changes the name of attribute that is attached to the object specified by loc_id. The attribute named old_attr_name is renamed new_attr_name.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location or object identifier; may be dataset or group </td></tr> + <tr><td class="paramname">old_attr_name</td><td>IN: Prior attribute name </td></tr> + <tr><td class="paramname">new_attr_name</td><td>IN: New attribute name</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A non-negative value if successful; 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>Name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga3643633f5b07620ec3f0a91f87845fba"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3643633f5b07620ec3f0a91f87845fba">◆ </a></span>H5Arename_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Arename_by_name </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>obj_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>old_attr_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>new_attr_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>lapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Arename_by_name changes the name of attribute that is attached to the object specified by loc_id and obj_name. The attribute named old_attr_name is renamed new_attr_name.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>IN: Location or object identifier; may be dataset or group </td></tr> + <tr><td class="paramname">obj_name</td><td>IN: Name of object, relative to location, whose attribute is to be renamed </td></tr> + <tr><td class="paramname">old_attr_name</td><td>IN: Prior attribute name </td></tr> + <tr><td class="paramname">new_attr_name</td><td>IN: New attribute name </td></tr> + <tr><td class="paramname">lapl_id</td><td>IN: Link access property list</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A non-negative value if successful; 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>Name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga54c06473da6ec647147a5d36cb532b2b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga54c06473da6ec647147a5d36cb532b2b">◆ </a></span>H5Awrite() <span class="overload">[1/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Awrite </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>buf</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buf to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga7ffe09818ce28adde61601f8eca4b98b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7ffe09818ce28adde61601f8eca4b98b">◆ </a></span>H5Awrite() <span class="overload">[2/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Awrite </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buf to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer with data to be written to the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>IN: request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gadc25ad6e54478ced9a6c8b5a90a38502"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadc25ad6e54478ced9a6c8b5a90a38502">◆ </a></span>H5Awrite() <span class="overload">[3/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Awrite </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Object </td> + <td class="paramname"><em>obj</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_exception.html">HDF5Exception</a>, <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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buf to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">obj</td><td>IN: Buffer with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaaf7d64c744618212952ff6aa0475aa65"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaaf7d64c744618212952ff6aa0475aa65">◆ </a></span>H5Awrite() <span class="overload">[4/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Awrite </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Object </td> + <td class="paramname"><em>obj</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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_exception.html">HDF5Exception</a>, <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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from data object to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">obj</td><td>IN: Data object to be written. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5Exception</td><td>Failure in the data conversion. </td></tr> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data object is null </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga24140794434a0e37a8f904824696fa27"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga24140794434a0e37a8f904824696fa27">◆ </a></span>H5Awrite_double() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Awrite_double </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double[] </td> + <td class="paramname"><em>buf</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of double to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of double with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga2cfb8294a0e63bdd995a1f08b550cc8c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2cfb8294a0e63bdd995a1f08b550cc8c">◆ </a></span>H5Awrite_double() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Awrite_double </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of double to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of double with data to be written to the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>IN: request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaa5df34930852dbedf33451861a6535f7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa5df34930852dbedf33451861a6535f7">◆ </a></span>H5Awrite_float() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Awrite_float </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float[] </td> + <td class="paramname"><em>buf</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of float to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of float with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gad01a334aa1d989fce739be069109b6b6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad01a334aa1d989fce739be069109b6b6">◆ </a></span>H5Awrite_float() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Awrite_float </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of float to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of float with data to be written to the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>IN: request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga19b87f17c6d5e6ddd6733390e3a43c5e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga19b87f17c6d5e6ddd6733390e3a43c5e">◆ </a></span>H5Awrite_int() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Awrite_int </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>buf</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of int to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of int with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaf2747a62d729e6f464b89d27f3e513f1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf2747a62d729e6f464b89d27f3e513f1">◆ </a></span>H5Awrite_int() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Awrite_int </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of int to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of int with data to be written to the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>IN: request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga81b3d894b91daa0b72ecd8f8f03623a5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga81b3d894b91daa0b72ecd8f8f03623a5">◆ </a></span>H5Awrite_long() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Awrite_long </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>buf</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of long to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of long with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gabc4ce2ad7044f6105e2c4b5d397559fa"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabc4ce2ad7044f6105e2c4b5d397559fa">◆ </a></span>H5Awrite_long() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Awrite_long </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of long to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of long with data to be written to the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>IN: request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gab5fc756b54a8c4ccd824b4a2df4ae71b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab5fc756b54a8c4ccd824b4a2df4ae71b">◆ </a></span>H5Awrite_short() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Awrite_short </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">short[] </td> + <td class="paramname"><em>buf</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of short to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of short with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga41f45d3867ee38da211f7c593ab07ebb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga41f45d3867ee38da211f7c593ab07ebb">◆ </a></span>H5Awrite_short() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Awrite_short </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">short[] </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"><em>isCriticalPinning</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of short to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of short with data to be written to the file. </td></tr> + <tr><td class="paramname">isCriticalPinning</td><td>IN: request lock on data reference.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaeb7be2cda75ecbb92d5e45b2fa3239d7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaeb7be2cda75ecbb92d5e45b2fa3239d7">◆ </a></span>H5Awrite_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 int H5Awrite_string </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"><em>buf</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of string to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of string with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gada48a09474de16493bad95d2d65280a1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gada48a09474de16493bad95d2d65280a1">◆ </a></span>H5Awrite_VLStrings()</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 H5Awrite_VLStrings </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Object[] </td> + <td class="paramname"><em>buf</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>H5Awrite_VLStrings writes a variable length String dataset, specified by its identifier attr_id, from the application memory buffer buffer of variable-lenght strings into the file.</p> +<p>-— contributed by Rosetta Biosoftware</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>Identifier of the attribute read from. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>Identifier of the memory datatype. </td></tr> + <tr><td class="paramname">buf</td><td>Buffer of variable-lenght strings with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga31fe569cd880bfd57fbd77ab2fee7654"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga31fe569cd880bfd57fbd77ab2fee7654">◆ </a></span>H5AwriteVL()</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 H5AwriteVL </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>attr_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>mem_type_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Object[] </td> + <td class="paramname"><em>buf</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>H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buffer of variable-lenght to the file.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">attr_id</td><td>IN: Identifier of an attribute to write. </td></tr> + <tr><td class="paramname">mem_type_id</td><td>IN: Identifier of the attribute datatype (in memory). </td></tr> + <tr><td class="paramname">buf</td><td>IN: Buffer of variable-lenght with data to be written to the file.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>data is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated on Mon Jun 26 2023 19:01:37 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> |