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___h5_p_t.html | |
| parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
| download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 | |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'group___h5_p_t.html')
| -rw-r--r-- | group___h5_p_t.html | 880 |
1 files changed, 880 insertions, 0 deletions
diff --git a/group___h5_p_t.html b/group___h5_p_t.html new file mode 100644 index 0000000..ee9d1cd --- /dev/null +++ b/group___h5_p_t.html @@ -0,0 +1,880 @@ +<!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: HDF5 Packet Table APIs (H5PT)</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___h5_p_t.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">HDF5 Packet Table APIs (H5PT)</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p><em>Creating and manipulating HDF5 datasets to support append- and read-only operations on table data (H5PT)</em></p> +<p>The HDF5 Packet Table API is designed to allow records to be appended to and read from a table. Packet Table datasets are chunked, allowing them to grow as needed.</p> +<p>The Packet Table API, with the H5PT prefix, is not to be confused with the H5TB Table API (H5TB prefix). The H5TB APIs are stateless (H5TB Tables do not need to be opened or closed) but H5PT Packet Tables require less performance overhead. Also, H5TB Tables support insertions and deletions, while H5PT Packet Tables support only append operations. H5TB functions should not be called on tables created with the H5PT API, or vice versa.</p> +<p>Packet Tables are datasets in an HDF5 file, so while their contents should not be changed outside of the H5PT API calls, the datatypes of Packet Tables can be queried using <a class="el" href="group___h5_d.html#ga7cd04b8332e8a0939b9973fbc500cadb">H5Dget_type</a>. Packet Tables can also be given attributes using the normal HDF5 APIs.</p> +<dl class="section note"><dt>Note</dt><dd><b>Programming hints:</b> </dd> +<dd> +The following line includes the HDF5 Packet Table package, H5PT, in C applications: <div class="fragment"><div class="line"><span class="preprocessor">#include "hdf5_hl.h"</span> </div> +</div><!-- fragment --> Without this include, an application will not have access to these functions.</dd></dl> +<ul> +<li><a class="el" href="group___h5_p_t.html#gae73861e153e86df61f24c5736c9dbb1c">H5PTappend</a> <br /> + Appends packets to the end of a packet table.</li> +<li><a class="el" href="group___h5_p_t.html#gaf9f4fe7b207aaa7aa63b17cee625c0e2">H5PTclose</a> <br /> + Closes an open packet table.</li> +<li><a class="el" href="group___h5_p_t.html#ga1f5ab7315bfb892ea51cc1cbaa78010b">H5PTcreate</a> <br /> + Creates a packet table to store fixed-length or variable-length packets.</li> +<li><a class="el" href="group___h5_p_t.html#gae49bb0e714fd3dfff6141bfb85a331ce">H5PTcreate_fl</a> <br /> + Creates a packet table to store fixed-length packets.</li> +<li><a class="el" href="group___h5_p_t.html#ga663f235cfcf8676636224f7b19629513">H5PTcreate_index</a> <br /> + Resets a packet table's index to the first packet.</li> +<li><a class="el" href="group___h5_p_t.html#ga8b078a7c9898869f8c3a35da40065ad7">H5PTfree_vlen_buff</a> <br /> + Releases memory allocated in the process of reading variable-length packets.</li> +<li><a class="el" href="group___h5_p_t.html#gaa6c6799b38ad7d3f5d02633d61dab58f">H5PTget_dataset</a> <br /> + Returns the backend dataset of this packet table.</li> +<li><a class="el" href="group___h5_p_t.html#ga7b1e7efcc3bf1f2f9476ec3ff7d24532">H5PTget_index</a> <br /> + Gets the current record index for a packet table</li> +<li><a class="el" href="group___h5_p_t.html#ga88988f5548b7be3efe20c4af32e6d440">H5PTget_next</a> <br /> + Reads packets from a packet table starting at the current index.</li> +<li><a class="el" href="group___h5_p_t.html#gafcb0b70001557c14840ec58bcb46ba4d">H5PTget_num_packets</a> <br /> + Returns the number of packets in a packet table.</li> +<li><a class="el" href="group___h5_p_t.html#gafcaf63e9606f70b5cef2b3e6aa394c36">H5PTget_type</a> <br /> + Returns the backend datatype of this packet table.</li> +<li><a class="el" href="group___h5_p_t.html#ga5200eb8cf2d4f8fb5bd455c5e6616a86">H5PTis_valid</a> <br /> + Determines whether an identifier points to a packet table.</li> +<li><a class="el" href="group___h5_p_t.html#ga118f7300157d7992459032d851afcd95">H5PTis_varlen</a> <br /> + Determines whether a packet table contains variable-length or fixed-length packets.</li> +<li><a class="el" href="group___h5_p_t.html#ga15a7ab544d6147aaf68ae42545f88acf">H5PTopen</a> <br /> + Opens an existing packet table.</li> +<li><a class="el" href="group___h5_p_t.html#gaf74154d76b4f12b82fc59ed816e98578">H5PTread_packets</a> <br /> + Reads a number of packets from a packet table.</li> +<li><a class="el" href="group___h5_p_t.html#ga2edb6d88047d4de85c3aaed36b79a57d">H5PTset_index</a> <br /> + Sets a packet table's index. </li> +</ul> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ga1f5ab7315bfb892ea51cc1cbaa78010b"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#ga1f5ab7315bfb892ea51cc1cbaa78010b">H5PTcreate</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *dset_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dtype_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> chunk_size, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id)</td></tr> +<tr class="memdesc:ga1f5ab7315bfb892ea51cc1cbaa78010b"><td class="mdescLeft"> </td><td class="mdescRight">Creates a packet table to store fixed-length or variable-length packets. <a href="group___h5_p_t.html#ga1f5ab7315bfb892ea51cc1cbaa78010b">More...</a><br /></td></tr> +<tr class="separator:ga1f5ab7315bfb892ea51cc1cbaa78010b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga15a7ab544d6147aaf68ae42545f88acf"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#ga15a7ab544d6147aaf68ae42545f88acf">H5PTopen</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *dset_name)</td></tr> +<tr class="memdesc:ga15a7ab544d6147aaf68ae42545f88acf"><td class="mdescLeft"> </td><td class="mdescRight">Opens an existing packet table. <a href="group___h5_p_t.html#ga15a7ab544d6147aaf68ae42545f88acf">More...</a><br /></td></tr> +<tr class="separator:ga15a7ab544d6147aaf68ae42545f88acf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf9f4fe7b207aaa7aa63b17cee625c0e2"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#gaf9f4fe7b207aaa7aa63b17cee625c0e2">H5PTclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id)</td></tr> +<tr class="memdesc:gaf9f4fe7b207aaa7aa63b17cee625c0e2"><td class="mdescLeft"> </td><td class="mdescRight">Closes an open packet table. <a href="group___h5_p_t.html#gaf9f4fe7b207aaa7aa63b17cee625c0e2">More...</a><br /></td></tr> +<tr class="separator:gaf9f4fe7b207aaa7aa63b17cee625c0e2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae49bb0e714fd3dfff6141bfb85a331ce"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#gae49bb0e714fd3dfff6141bfb85a331ce">H5PTcreate_fl</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *dset_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dtype_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> chunk_size, int compression)</td></tr> +<tr class="memdesc:gae49bb0e714fd3dfff6141bfb85a331ce"><td class="mdescLeft"> </td><td class="mdescRight">Creates a packet table to store fixed-length packets. <a href="group___h5_p_t.html#gae49bb0e714fd3dfff6141bfb85a331ce">More...</a><br /></td></tr> +<tr class="separator:gae49bb0e714fd3dfff6141bfb85a331ce"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae73861e153e86df61f24c5736c9dbb1c"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#gae73861e153e86df61f24c5736c9dbb1c">H5PTappend</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id, size_t nrecords, const void *data)</td></tr> +<tr class="memdesc:gae73861e153e86df61f24c5736c9dbb1c"><td class="mdescLeft"> </td><td class="mdescRight">Appends packets to the end of a packet table. <a href="group___h5_p_t.html#gae73861e153e86df61f24c5736c9dbb1c">More...</a><br /></td></tr> +<tr class="separator:gae73861e153e86df61f24c5736c9dbb1c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga88988f5548b7be3efe20c4af32e6d440"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#ga88988f5548b7be3efe20c4af32e6d440">H5PTget_next</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id, size_t nrecords, void *data)</td></tr> +<tr class="memdesc:ga88988f5548b7be3efe20c4af32e6d440"><td class="mdescLeft"> </td><td class="mdescRight">Reads packets from a packet table starting at the current index. <a href="group___h5_p_t.html#ga88988f5548b7be3efe20c4af32e6d440">More...</a><br /></td></tr> +<tr class="separator:ga88988f5548b7be3efe20c4af32e6d440"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf74154d76b4f12b82fc59ed816e98578"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#gaf74154d76b4f12b82fc59ed816e98578">H5PTread_packets</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> start, size_t nrecords, void *data)</td></tr> +<tr class="memdesc:gaf74154d76b4f12b82fc59ed816e98578"><td class="mdescLeft"> </td><td class="mdescRight">Reads a number of packets from a packet table. <a href="group___h5_p_t.html#gaf74154d76b4f12b82fc59ed816e98578">More...</a><br /></td></tr> +<tr class="separator:gaf74154d76b4f12b82fc59ed816e98578"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafcb0b70001557c14840ec58bcb46ba4d"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#gafcb0b70001557c14840ec58bcb46ba4d">H5PTget_num_packets</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *nrecords)</td></tr> +<tr class="memdesc:gafcb0b70001557c14840ec58bcb46ba4d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of packets in a packet table. <a href="group___h5_p_t.html#gafcb0b70001557c14840ec58bcb46ba4d">More...</a><br /></td></tr> +<tr class="separator:gafcb0b70001557c14840ec58bcb46ba4d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5200eb8cf2d4f8fb5bd455c5e6616a86"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#ga5200eb8cf2d4f8fb5bd455c5e6616a86">H5PTis_valid</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id)</td></tr> +<tr class="memdesc:ga5200eb8cf2d4f8fb5bd455c5e6616a86"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether an identifier points to a packet table. <a href="group___h5_p_t.html#ga5200eb8cf2d4f8fb5bd455c5e6616a86">More...</a><br /></td></tr> +<tr class="separator:ga5200eb8cf2d4f8fb5bd455c5e6616a86"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga118f7300157d7992459032d851afcd95"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#ga118f7300157d7992459032d851afcd95">H5PTis_varlen</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id)</td></tr> +<tr class="memdesc:ga118f7300157d7992459032d851afcd95"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a packet table contains variable-length or fixed-length packets. <a href="group___h5_p_t.html#ga118f7300157d7992459032d851afcd95">More...</a><br /></td></tr> +<tr class="separator:ga118f7300157d7992459032d851afcd95"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa6c6799b38ad7d3f5d02633d61dab58f"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#gaa6c6799b38ad7d3f5d02633d61dab58f">H5PTget_dataset</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id)</td></tr> +<tr class="memdesc:gaa6c6799b38ad7d3f5d02633d61dab58f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the backend dataset of this packet table. <a href="group___h5_p_t.html#gaa6c6799b38ad7d3f5d02633d61dab58f">More...</a><br /></td></tr> +<tr class="separator:gaa6c6799b38ad7d3f5d02633d61dab58f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafcaf63e9606f70b5cef2b3e6aa394c36"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#gafcaf63e9606f70b5cef2b3e6aa394c36">H5PTget_type</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id)</td></tr> +<tr class="memdesc:gafcaf63e9606f70b5cef2b3e6aa394c36"><td class="mdescLeft"> </td><td class="mdescRight">Returns the backend datatype of this packet table. <a href="group___h5_p_t.html#gafcaf63e9606f70b5cef2b3e6aa394c36">More...</a><br /></td></tr> +<tr class="separator:gafcaf63e9606f70b5cef2b3e6aa394c36"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga663f235cfcf8676636224f7b19629513"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#ga663f235cfcf8676636224f7b19629513">H5PTcreate_index</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id)</td></tr> +<tr class="memdesc:ga663f235cfcf8676636224f7b19629513"><td class="mdescLeft"> </td><td class="mdescRight">Resets a packet table's index to the first packet. <a href="group___h5_p_t.html#ga663f235cfcf8676636224f7b19629513">More...</a><br /></td></tr> +<tr class="separator:ga663f235cfcf8676636224f7b19629513"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2edb6d88047d4de85c3aaed36b79a57d"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#ga2edb6d88047d4de85c3aaed36b79a57d">H5PTset_index</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> pt_index)</td></tr> +<tr class="memdesc:ga2edb6d88047d4de85c3aaed36b79a57d"><td class="mdescLeft"> </td><td class="mdescRight">Sets a packet table's index. <a href="group___h5_p_t.html#ga2edb6d88047d4de85c3aaed36b79a57d">More...</a><br /></td></tr> +<tr class="separator:ga2edb6d88047d4de85c3aaed36b79a57d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7b1e7efcc3bf1f2f9476ec3ff7d24532"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#ga7b1e7efcc3bf1f2f9476ec3ff7d24532">H5PTget_index</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *pt_index)</td></tr> +<tr class="memdesc:ga7b1e7efcc3bf1f2f9476ec3ff7d24532"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current record index for a packet table. <a href="group___h5_p_t.html#ga7b1e7efcc3bf1f2f9476ec3ff7d24532">More...</a><br /></td></tr> +<tr class="separator:ga7b1e7efcc3bf1f2f9476ec3ff7d24532"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8b078a7c9898869f8c3a35da40065ad7"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_p_t.html#ga8b078a7c9898869f8c3a35da40065ad7">H5PTfree_vlen_buff</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> table_id, size_t bufflen, void *buff)</td></tr> +<tr class="memdesc:ga8b078a7c9898869f8c3a35da40065ad7"><td class="mdescLeft"> </td><td class="mdescRight">Releases memory allocated in the process of reading variable-length packets. <a href="group___h5_p_t.html#ga8b078a7c9898869f8c3a35da40065ad7">More...</a><br /></td></tr> +<tr class="separator:ga8b078a7c9898869f8c3a35da40065ad7"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="gae73861e153e86df61f24c5736c9dbb1c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae73861e153e86df61f24c5736c9dbb1c">◆ </a></span>H5PTappend()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTappend </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Appends packets to the end of a packet table. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier of packet table to which packets should be appended </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">nrecords</td><td>Number of packets to be appended </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Buffer holding data to write</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#gae73861e153e86df61f24c5736c9dbb1c" title="Appends packets to the end of a packet table.">H5PTappend()</a> writes <code>nrecords</code> packets to the end of a packet table specified by <code>table_id</code>. <code>data</code> is a buffer containing the data to be written. For a packet table holding fixed-length packets, this data should be in the packet table's datatype. For a variable-length packet table, the data should be in the form of <a class="el" href="structhvl__t.html">hvl_t</a> structs. </p> + +</div> +</div> +<a id="gaf9f4fe7b207aaa7aa63b17cee625c0e2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf9f4fe7b207aaa7aa63b17cee625c0e2">◆ </a></span>H5PTclose()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTclose </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Closes an open packet table. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier of packet table to be closed</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#gaf9f4fe7b207aaa7aa63b17cee625c0e2" title="Closes an open packet table.">H5PTclose()</a> ends access to a packet table specified by <code>table_id</code>. </p> + +</div> +</div> +<a id="ga1f5ab7315bfb892ea51cc1cbaa78010b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1f5ab7315bfb892ea51cc1cbaa78010b">◆ </a></span>H5PTcreate()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5PTcreate </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>dtype_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td> + <td class="paramname"><em>chunk_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>plist_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates a packet table to store fixed-length or variable-length packets. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">dset_name</td><td>The name of the packet table to create </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">dtype_id</td><td>The datatype of the packet </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">chunk_size</td><td>The size in number of table entries per chunk </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Identifier of the property list. Can be used to specify the compression of the packet table.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns an identifier for the new packet table or <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a> on error.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#ga1f5ab7315bfb892ea51cc1cbaa78010b" title="Creates a packet table to store fixed-length or variable-length packets.">H5PTcreate()</a> creates and opens a packet table named <code>dset_name</code> attached to the object specified by the identifier <code>loc_id</code>. The created packet table should be closed with <a class="el" href="group___h5_p_t.html#gaf9f4fe7b207aaa7aa63b17cee625c0e2" title="Closes an open packet table.">H5PTclose()</a>, eventually.</p> +<p>The datatype, <code>dtype_id</code>, may specify any datatype, including variable-length data. If <code>dtype_id</code> specifies a compound datatype, one or more fields in that compound type may be variable-length.</p> +<p><code>chunk_size</code> is the size in number of table entries per chunk. Packet table datasets use HDF5 chunked storage to allow them to grow. This value allows the user to set the size of a chunk. The chunk size affects performance.</p> +<dl class="section since"><dt>Since</dt><dd>1.10.0 and 1.8.17 </dd></dl> + +</div> +</div> +<a id="gae49bb0e714fd3dfff6141bfb85a331ce"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae49bb0e714fd3dfff6141bfb85a331ce">◆ </a></span>H5PTcreate_fl()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5PTcreate_fl </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>dtype_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td> + <td class="paramname"><em>chunk_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>compression</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates a packet table to store fixed-length packets. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">dset_name</td><td>The name of the dataset to create </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">dtype_id</td><td>The datatype of a packet. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">chunk_size</td><td>The size in number of table entries per chunk. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">compression</td><td>The compression level; a value of 0 through 9.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns an identifier for the packet table or <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a> on error.</dd></dl> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>This function was deprecated in favor of the function <a class="el" href="group___h5_p_t.html#ga1f5ab7315bfb892ea51cc1cbaa78010b" title="Creates a packet table to store fixed-length or variable-length packets.">H5PTcreate()</a>.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#gae49bb0e714fd3dfff6141bfb85a331ce" title="Creates a packet table to store fixed-length packets.">H5PTcreate_fl()</a> creates and opens a packet table named <code>dset_name</code> attached to the object specified by the identifier <code>loc_id</code>. It should be closed with <a class="el" href="group___h5_p_t.html#gaf9f4fe7b207aaa7aa63b17cee625c0e2" title="Closes an open packet table.">H5PTclose()</a>.</p> +<p>The datatype, <code>dtype_id</code>, may specify any datatype, including variable-length data. If <code>dtype_id</code> specifies a compound datatype, one or more fields in that compound type may be variable-length.</p> +<p><code>chunk_size</code> is the size in number of table entries per chunk. Packet table datasets use HDF5 chunked storage to allow them to grow. This value allows the user to set the size of a chunk. The chunk size affects performance.</p> +<p><code>compression</code> is the compression level, a value of 0 through 9. Level 0 is faster but offers the least compression; level 9 is slower but offers maximum compression. A setting of -1 indicates that no compression is desired. </p> + +</div> +</div> +<a id="ga663f235cfcf8676636224f7b19629513"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga663f235cfcf8676636224f7b19629513">◆ </a></span>H5PTcreate_index()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTcreate_index </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Resets a packet table's index to the first packet. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier of packet table whose index should be initialized.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>Each packet table keeps an index of the "current" packet so that <code>get_next</code> can iterate through the packets in order. <a class="el" href="group___h5_p_t.html#ga663f235cfcf8676636224f7b19629513" title="Resets a packet table's index to the first packet.">H5PTcreate_index()</a> initializes a packet table's index, and should be called before using <code>get_next</code>. The index must be initialized every time a packet table is created or opened; this information is lost when the packet table is closed. </p> + +</div> +</div> +<a id="ga8b078a7c9898869f8c3a35da40065ad7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8b078a7c9898869f8c3a35da40065ad7">◆ </a></span>H5PTfree_vlen_buff()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTfree_vlen_buff </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>bufflen</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>buff</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Releases memory allocated in the process of reading variable-length packets. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Packet table whose memory should be freed. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">bufflen</td><td>Size of <code>buff</code> </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">buff</td><td>Buffer that was used to read in variable-length packets</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>When variable-length packets are read, memory is automatically allocated to hold them, and must be freed. <a class="el" href="group___h5_p_t.html#ga8b078a7c9898869f8c3a35da40065ad7" title="Releases memory allocated in the process of reading variable-length packets.">H5PTfree_vlen_buff()</a> frees this memory, and should be called whenever packets are read from a variable-length packet table.</p> +<dl class="section version"><dt>Version</dt><dd>1.10.0 and 1.8.17 Function re-introduced. Function had been removed in 1.8.3. </dd></dl> + +</div> +</div> +<a id="gaa6c6799b38ad7d3f5d02633d61dab58f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa6c6799b38ad7d3f5d02633d61dab58f">◆ </a></span>H5PTget_dataset()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5PTget_dataset </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the backend dataset of this packet table. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier of the packet table</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a dataset identifier or H5I_INVALID_HID on error.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#gaa6c6799b38ad7d3f5d02633d61dab58f" title="Returns the backend dataset of this packet table.">H5PTget_dataset()</a> returns the identifier of the dataset storing the packet table <code>table_id</code>. This dataset identifier will be closed by <a class="el" href="group___h5_p_t.html#gaf9f4fe7b207aaa7aa63b17cee625c0e2" title="Closes an open packet table.">H5PTclose()</a>.</p> +<dl class="section since"><dt>Since</dt><dd>1.10.0 and 1.8.17 </dd></dl> + +</div> +</div> +<a id="ga7b1e7efcc3bf1f2f9476ec3ff7d24532"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7b1e7efcc3bf1f2f9476ec3ff7d24532">◆ </a></span>H5PTget_index()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTget_index </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td> + <td class="paramname"><em>pt_index</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Gets the current record index for a packet table. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Table identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pt_index</td><td>Current record index</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#ga7b1e7efcc3bf1f2f9476ec3ff7d24532" title="Gets the current record index for a packet table.">H5PTget_index()</a> returns the current record index <code>pt_index</code> for the table identified by <code>table_id</code>.</p> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="ga88988f5548b7be3efe20c4af32e6d440"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga88988f5548b7be3efe20c4af32e6d440">◆ </a></span>H5PTget_next()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTget_next </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Reads packets from a packet table starting at the current index. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier of packet table to read from </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">nrecords</td><td>Number of packets to be read </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Buffer into which to read data</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#ga88988f5548b7be3efe20c4af32e6d440" title="Reads packets from a packet table starting at the current index.">H5PTget_next()</a> reads <code>nrecords</code> packets starting with the "current index" from a packet table specified by <code>table_id</code>. The packet table's index is set and reset with <a class="el" href="group___h5_p_t.html#ga2edb6d88047d4de85c3aaed36b79a57d" title="Sets a packet table's index.">H5PTset_index()</a> and <a class="el" href="group___h5_p_t.html#ga663f235cfcf8676636224f7b19629513" title="Resets a packet table's index to the first packet.">H5PTcreate_index()</a>. <code>data</code> is a buffer into which the data should be read.</p> +<p>For a packet table holding variable-length records, the data returned in the buffer will be in form of a <a class="el" href="structhvl__t.html">hvl_t</a> struct containing the length of the data and a pointer to it in memory. The memory used by this data must be freed using <a class="el" href="group___h5_p_t.html#ga8b078a7c9898869f8c3a35da40065ad7" title="Releases memory allocated in the process of reading variable-length packets.">H5PTfree_vlen_buff()</a>. </p> + +</div> +</div> +<a id="gafcb0b70001557c14840ec58bcb46ba4d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafcb0b70001557c14840ec58bcb46ba4d">◆ </a></span>H5PTget_num_packets()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTget_num_packets </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td> + <td class="paramname"><em>nrecords</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the number of packets in a packet table. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier of packet table to query </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">nrecords</td><td>Number of packets in packet table</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#gafcb0b70001557c14840ec58bcb46ba4d" title="Returns the number of packets in a packet table.">H5PTget_num_packets()</a> returns by reference the number of packets in a packet table specified by <code>table_id</code>. </p> + +</div> +</div> +<a id="gafcaf63e9606f70b5cef2b3e6aa394c36"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafcaf63e9606f70b5cef2b3e6aa394c36">◆ </a></span>H5PTget_type()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5PTget_type </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the backend datatype of this packet table. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier of the packet table</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a datatype identifier or H5I_INVALID_HID on error.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#gafcaf63e9606f70b5cef2b3e6aa394c36" title="Returns the backend datatype of this packet table.">H5PTget_type()</a> returns the identifier of the datatype used by the packet table <code>table_id</code>. This datatype identifier will be closed by <a class="el" href="group___h5_p_t.html#gaf9f4fe7b207aaa7aa63b17cee625c0e2" title="Closes an open packet table.">H5PTclose()</a>.</p> +<dl class="section since"><dt>Since</dt><dd>1.10.0 and 1.8.17 </dd></dl> + +</div> +</div> +<a id="ga5200eb8cf2d4f8fb5bd455c5e6616a86"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5200eb8cf2d4f8fb5bd455c5e6616a86">◆ </a></span>H5PTis_valid()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTis_valid </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determines whether an identifier points to a packet table. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier to query</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if <code>table_id</code> is a valid packet table, otherwise returns a negative value.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#ga5200eb8cf2d4f8fb5bd455c5e6616a86" title="Determines whether an identifier points to a packet table.">H5PTis_valid()</a> returns a non-negative value if <code>table_id</code> corresponds to an open packet table, and returns a negative value otherwise. </p> + +</div> +</div> +<a id="ga118f7300157d7992459032d851afcd95"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga118f7300157d7992459032d851afcd95">◆ </a></span>H5PTis_varlen()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTis_varlen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determines whether a packet table contains variable-length or fixed-length packets. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Packet table to query</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns 1 for a variable-length packet table, 0 for fixed-length, or a negative value on error.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#ga118f7300157d7992459032d851afcd95" title="Determines whether a packet table contains variable-length or fixed-length packets.">H5PTis_varlen()</a> returns 1 (TRUE) if <code>table_id</code> is a packet table containing variable-length records. It returns 0 (FALSE) if <code>table_id</code> is a packet table containing fixed-length records. If <code>table_id</code> is not a packet table, a negative value is returned.</p> +<dl class="section version"><dt>Version</dt><dd>1.10.0 and 1.8.17 Function re-introduced. Function had been removed in 1.8.3. </dd></dl> + +</div> +</div> +<a id="ga15a7ab544d6147aaf68ae42545f88acf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga15a7ab544d6147aaf68ae42545f88acf">◆ </a></span>H5PTopen()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5PTopen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>dset_name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Opens an existing packet table. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">dset_name</td><td>The name of the packet table to open</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns an identifier for the packet table or <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a> on error.</dd></dl> +<p><a class="el" href="group___h5_p_t.html#ga15a7ab544d6147aaf68ae42545f88acf" title="Opens an existing packet table.">H5PTopen()</a> opens an existing packet table in the file or group specified by <code>loc_id</code>. <code>dset_name</code> is the name of the packet table and is used to identify it in the file. This function is used to open both fixed-length packet tables and variable-length packet tables. The packet table should later be closed with <a class="el" href="group___h5_p_t.html#gaf9f4fe7b207aaa7aa63b17cee625c0e2" title="Closes an open packet table.">H5PTclose()</a>. </p> + +</div> +</div> +<a id="gaf74154d76b4f12b82fc59ed816e98578"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf74154d76b4f12b82fc59ed816e98578">◆ </a></span>H5PTread_packets()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTread_packets </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Reads a number of packets from a packet table. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier of packet table to read from </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Packet to start reading from </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">nrecords</td><td>Number of packets to be read </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Buffer into which to read data.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>The <a class="el" href="group___h5_p_t.html#gaf74154d76b4f12b82fc59ed816e98578" title="Reads a number of packets from a packet table.">H5PTread_packets()</a> reads <code>nrecords</code> packets starting at packet number <code>start</code> from a packet table specified by <code>table_id</code>. <code>data</code> is a buffer into which the data should be read.</p> +<p>For a packet table holding variable-length records, the data returned in the buffer will be in form of <a class="el" href="structhvl__t.html">hvl_t</a> structs, each containing the length of the data and a pointer to it in memory. The memory used by this data must be freed using <a class="el" href="group___h5_p_t.html#ga8b078a7c9898869f8c3a35da40065ad7" title="Releases memory allocated in the process of reading variable-length packets.">H5PTfree_vlen_buff()</a>. </p> + +</div> +</div> +<a id="ga2edb6d88047d4de85c3aaed36b79a57d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2edb6d88047d4de85c3aaed36b79a57d">◆ </a></span>H5PTset_index()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PTset_index </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>table_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td> + <td class="paramname"><em>pt_index</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets a packet table's index. </p> +<hr /> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">table_id</td><td>Identifier of packet table whose index is to be set </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pt_index</td><td>The packet to which the index should point</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<p>Each packet table keeps an index of the "current" packet so that <code>get_next</code> can iterate through the packets in order. <a class="el" href="group___h5_p_t.html#ga2edb6d88047d4de85c3aaed36b79a57d" title="Sets a packet table's index.">H5PTset_index()</a> sets this index to point to a user-specified packet (the packets are zero-indexed). </p> + +</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> |