diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
| commit | 4f20d880c97be1249f8d89ced95f72836dbf3ee0 (patch) | |
| tree | 30d8dcb282134b7126b092796f2be00d2d97bd3c /develop/group___f_h5_t_b.html | |
| parent | 4e7e457497c948b41c8b0065225875bf10cdf9d4 (diff) | |
| download | hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.zip hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.gz hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.bz2 | |
deploy: ef39882fa1e13740d2530c7a0637bd1f1a822b68
Diffstat (limited to 'develop/group___f_h5_t_b.html')
| -rw-r--r-- | develop/group___f_h5_t_b.html | 1064 |
1 files changed, 1064 insertions, 0 deletions
diff --git a/develop/group___f_h5_t_b.html b/develop/group___f_h5_t_b.html new file mode 100644 index 0000000..e9749fc --- /dev/null +++ b/develop/group___f_h5_t_b.html @@ -0,0 +1,1064 @@ +<!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: Fortran High Level Table (H5TB) 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.ef39882</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___f_h5_t_b.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/Subroutines</a> </div> + <div class="headertitle"> +<div class="title">Fortran High Level Table (H5TB) Interface</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_t_b.html">HDF5 Table APIs (H5TB)</a>, C-HL API</dd> +<dd> +<a class="el" href="_h5_t_b__u_g.html">The HDF5 High Level Table</a>, User Guide </dd></dl> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions/Subroutines</h2></td></tr> +<tr class="memitem:gab40cec6da64f38518ed3467ff14c4029"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#gab40cec6da64f38518ed3467ff14c4029">h5tbmake_table_f</a> (table_title, loc_id, dset_name, nfields, nrecords, type_size, field_names, field_offset, field_types, chunk_size, compress, errcode)</td></tr> +<tr class="memdesc:gab40cec6da64f38518ed3467ff14c4029"><td class="mdescLeft"> </td><td class="mdescRight">Creates (DOES NOT WRITE) a dataset named <code>dset_name</code> attached to the object specified by the identifier <code>loc_id</code>. <a href="group___f_h5_t_b.html#gab40cec6da64f38518ed3467ff14c4029">More...</a><br /></td></tr> +<tr class="separator:gab40cec6da64f38518ed3467ff14c4029"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac115d629c29684e579bf0b93aa28ce9c"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#gac115d629c29684e579bf0b93aa28ce9c">h5tbmake_table_f</a> (table_title, loc_id, dset_name, nfields, nrecords, type_size, field_names, field_offset, field_types, chunk_size, fill_data, compress, data, errcode)</td></tr> +<tr class="memdesc:gac115d629c29684e579bf0b93aa28ce9c"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes a dataset named <code>dset_name</code> attached to the object specified by the identifier <code>loc_id</code>. <a href="group___f_h5_t_b.html#gac115d629c29684e579bf0b93aa28ce9c">More...</a><br /></td></tr> +<tr class="separator:gac115d629c29684e579bf0b93aa28ce9c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5a1728f6a51879b96b2fcb72c133a1f6"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#ga5a1728f6a51879b96b2fcb72c133a1f6">h5tbread_table_f</a> (loc_id, dset_name, nfields, dst_size, dst_offset, dst_sizes, dst_buf, errcode)</td></tr> +<tr class="memdesc:ga5a1728f6a51879b96b2fcb72c133a1f6"><td class="mdescLeft"> </td><td class="mdescRight">Reads a table. <a href="group___f_h5_t_b.html#ga5a1728f6a51879b96b2fcb72c133a1f6">More...</a><br /></td></tr> +<tr class="separator:ga5a1728f6a51879b96b2fcb72c133a1f6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad5affc92b1409825d7b28c2fc7f6da9c"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#gad5affc92b1409825d7b28c2fc7f6da9c">h5tbwrite_field_name_f</a> (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)</td></tr> +<tr class="memdesc:gad5affc92b1409825d7b28c2fc7f6da9c"><td class="mdescLeft"> </td><td class="mdescRight">Overwrites field. <a href="group___f_h5_t_b.html#gad5affc92b1409825d7b28c2fc7f6da9c">More...</a><br /></td></tr> +<tr class="separator:gad5affc92b1409825d7b28c2fc7f6da9c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac5f0be340f1d9640d39bcf1c026f3cb0"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#gac5f0be340f1d9640d39bcf1c026f3cb0">h5tbread_field_name_f</a> (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)</td></tr> +<tr class="memdesc:gac5f0be340f1d9640d39bcf1c026f3cb0"><td class="mdescLeft"> </td><td class="mdescRight">Reads one or several fields. The fields are identified by name. <a href="group___f_h5_t_b.html#gac5f0be340f1d9640d39bcf1c026f3cb0">More...</a><br /></td></tr> +<tr class="separator:gac5f0be340f1d9640d39bcf1c026f3cb0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga336066162f632fcfb5880a90d94a26bf"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#ga336066162f632fcfb5880a90d94a26bf">h5tbwrite_field_index_f</a> (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)</td></tr> +<tr class="memdesc:ga336066162f632fcfb5880a90d94a26bf"><td class="mdescLeft"> </td><td class="mdescRight">Overwrites a field. <a href="group___f_h5_t_b.html#ga336066162f632fcfb5880a90d94a26bf">More...</a><br /></td></tr> +<tr class="separator:ga336066162f632fcfb5880a90d94a26bf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga764a493a6c66fcd0935c0f2f73f0ec4c"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#ga764a493a6c66fcd0935c0f2f73f0ec4c">h5tbread_field_index_f</a> (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)</td></tr> +<tr class="memdesc:ga764a493a6c66fcd0935c0f2f73f0ec4c"><td class="mdescLeft"> </td><td class="mdescRight">Reads field. The fields are identified by index. <a href="group___f_h5_t_b.html#ga764a493a6c66fcd0935c0f2f73f0ec4c">More...</a><br /></td></tr> +<tr class="separator:ga764a493a6c66fcd0935c0f2f73f0ec4c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0e1cbcd6be6ea64a60d0ab5edf1f45ca"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#ga0e1cbcd6be6ea64a60d0ab5edf1f45ca">h5tbinsert_field_f</a> (loc_id, dset_name, field_name, field_type, position, buf, errcode)</td></tr> +<tr class="memdesc:ga0e1cbcd6be6ea64a60d0ab5edf1f45ca"><td class="mdescLeft"> </td><td class="mdescRight">Insert a new field into a table. <a href="group___f_h5_t_b.html#ga0e1cbcd6be6ea64a60d0ab5edf1f45ca">More...</a><br /></td></tr> +<tr class="separator:ga0e1cbcd6be6ea64a60d0ab5edf1f45ca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga526c0d75150e5ba6ccdd6ad1be3ac2ab"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#ga526c0d75150e5ba6ccdd6ad1be3ac2ab">h5tbdelete_field_f</a> (loc_id, dset_name, field_name, errcode)</td></tr> +<tr class="memdesc:ga526c0d75150e5ba6ccdd6ad1be3ac2ab"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a field from a table. <a href="group___f_h5_t_b.html#ga526c0d75150e5ba6ccdd6ad1be3ac2ab">More...</a><br /></td></tr> +<tr class="separator:ga526c0d75150e5ba6ccdd6ad1be3ac2ab"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabc1c51e588cbc2e4b14dba04425dfdcd"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#gabc1c51e588cbc2e4b14dba04425dfdcd">h5tbget_table_info_f</a> (loc_id, dset_name, nfields, nrecords, errcode)</td></tr> +<tr class="memdesc:gabc1c51e588cbc2e4b14dba04425dfdcd"><td class="mdescLeft"> </td><td class="mdescRight">Gets the table dimensions. <a href="group___f_h5_t_b.html#gabc1c51e588cbc2e4b14dba04425dfdcd">More...</a><br /></td></tr> +<tr class="separator:gabc1c51e588cbc2e4b14dba04425dfdcd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa0363bf0bde0d8644661848d83916784"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_t_b.html#gaa0363bf0bde0d8644661848d83916784">h5tbget_field_info_f</a> (loc_id, dset_name, nfields, field_names, field_sizes, field_offsets, type_size, errcode, maxlen_out)</td></tr> +<tr class="memdesc:gaa0363bf0bde0d8644661848d83916784"><td class="mdescLeft"> </td><td class="mdescRight">Gets information about a table. <a href="group___f_h5_t_b.html#gaa0363bf0bde0d8644661848d83916784">More...</a><br /></td></tr> +<tr class="separator:gaa0363bf0bde0d8644661848d83916784"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function/Subroutine Documentation</h2> +<a id="ga526c0d75150e5ba6ccdd6ad1be3ac2ab"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga526c0d75150e5ba6ccdd6ad1be3ac2ab">◆ </a></span>h5tbdelete_field_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5tb::h5tbdelete_field_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>field_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Deletes a field from a table. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the table. </td></tr> + <tr><td class="paramname">field_name</td><td>The name of the field to delete. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_t_b.html#ga926016787829fad62541200bc003936b">H5TBdelete_field()</a> </p> + +</div> +</div> +<a id="gaa0363bf0bde0d8644661848d83916784"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa0363bf0bde0d8644661848d83916784">◆ </a></span>h5tbget_field_info_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5tb::h5tbget_field_info_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nfields</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), dimension(nfields), intent(inout) </td> + <td class="paramname"><em>field_names</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), dimension(nfields), intent(inout) </td> + <td class="paramname"><em>field_sizes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), dimension(nfields), intent(inout) </td> + <td class="paramname"><em>field_offsets</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(inout) </td> + <td class="paramname"><em>type_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), optional </td> + <td class="paramname"><em>maxlen_out</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Gets information about a table. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to read. </td></tr> + <tr><td class="paramname">nfields</td><td>The number of fields. </td></tr> + <tr><td class="paramname">field_names</td><td>An array containing the names of the fields. </td></tr> + <tr><td class="paramname">field_sizes</td><td>An array containing the size of the fields. </td></tr> + <tr><td class="paramname">field_offsets</td><td>An array containing the offsets of the fields. </td></tr> + <tr><td class="paramname">type_size</td><td>The size of the HDF5 datatype associated with the table (i.e., the size in bytes of the HDF5 compound datatype used to define a row, or record, in the table). </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails. </td></tr> + <tr><td class="paramname">maxlen_out</td><td>Maximum character length of the field names.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_t_b.html#gaa0f9db05008cec2c37de8487531000ba">H5TBget_field_info()</a> </p> + +</div> +</div> +<a id="gabc1c51e588cbc2e4b14dba04425dfdcd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabc1c51e588cbc2e4b14dba04425dfdcd">◆ </a></span>h5tbget_table_info_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5tb::h5tbget_table_info_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(inout) </td> + <td class="paramname"><em>nfields</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(inout) </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Gets the table dimensions. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to read. </td></tr> + <tr><td class="paramname">nfields</td><td>The number of fields. </td></tr> + <tr><td class="paramname">nrecords</td><td>The number of records. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_t_b.html#ga35c13910216330ca1768396ac7ecd99c">H5TBget_table_info()</a> </p> + +</div> +</div> +<a id="ga0e1cbcd6be6ea64a60d0ab5edf1f45ca"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0e1cbcd6be6ea64a60d0ab5edf1f45ca">◆ </a></span>h5tbinsert_field_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine <a class="el" href="interfaceh5tb_1_1h5tbinsert__field__f.html">h5tb::h5tbinsert_field_f</a> </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>field_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>field_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>position</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(type), dimension(*), intent(in) </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Insert a new field into a table. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the table. </td></tr> + <tr><td class="paramname">field_name</td><td>The name of the field to insert. </td></tr> + <tr><td class="paramname">field_type</td><td>The data type of the field. </td></tr> + <tr><td class="paramname">position</td><td>The zero based index position where to insert the field. </td></tr> + <tr><td class="paramname">buf</td><td>Buffer with data. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_t_b.html#gab70acdaa351b92be0e64fc54e42a98a7">H5TBinsert_field()</a> </p> + +</div> +</div> +<a id="gab40cec6da64f38518ed3467ff14c4029"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab40cec6da64f38518ed3467ff14c4029">◆ </a></span>h5tbmake_table_f() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5tb::h5tbmake_table_f </td> + <td>(</td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>table_title</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nfields</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(in) </td> + <td class="paramname"><em>type_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), dimension(1:nfields), intent(in) </td> + <td class="paramname"><em>field_names</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), dimension(1:nfields), intent(in) </td> + <td class="paramname"><em>field_offset</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), dimension(1:nfields), intent(in) </td> + <td class="paramname"><em>field_types</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>chunk_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>compress</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates (DOES NOT WRITE) a dataset named <code>dset_name</code> attached to the object specified by the identifier <code>loc_id</code>. </p> +<dl class="section attention"><dt>Attention</dt><dd>Obsolete API, use the Fortran 2003 version instead.</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">table_title</td><td>The title of the table. </td></tr> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to create. </td></tr> + <tr><td class="paramname">nfields</td><td>The number of fields. </td></tr> + <tr><td class="paramname">nrecords</td><td>The number of records. </td></tr> + <tr><td class="paramname">type_size</td><td>The size in bytes of the structure associated with the table. Obtained with sizeof or storage_size. </td></tr> + <tr><td class="paramname">field_names</td><td>An array containing the names of the fields. </td></tr> + <tr><td class="paramname">field_offset</td><td>An array containing the offsets of the fields. </td></tr> + <tr><td class="paramname">field_types</td><td>An array containing the type of the fields. </td></tr> + <tr><td class="paramname">chunk_size</td><td>The chunk size. </td></tr> + <tr><td class="paramname">compress</td><td>Flag that turns compression on or off. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_t_b.html#gacce384a15825421d1bddfc7b3ab1e7d0">H5TBmake_table()</a> </p> + +</div> +</div> +<a id="gac115d629c29684e579bf0b93aa28ce9c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac115d629c29684e579bf0b93aa28ce9c">◆ </a></span>h5tbmake_table_f() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5tb::h5tbmake_table_f </td> + <td>(</td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>table_title</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nfields</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(in) </td> + <td class="paramname"><em>type_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), dimension(1:nfields), intent(in) </td> + <td class="paramname"><em>field_names</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), dimension(1:nfields), intent(in) </td> + <td class="paramname"><em>field_offset</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), dimension(1:nfields), intent(in) </td> + <td class="paramname"><em>field_types</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>chunk_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in) </td> + <td class="paramname"><em>fill_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>compress</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr), intent(in) </td> + <td class="paramname"><em>data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates and writes a dataset named <code>dset_name</code> attached to the object specified by the identifier <code>loc_id</code>. </p> +<dl class="section attention"><dt>Attention</dt><dd>The preferred API, Fortran 2003 version.</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">table_title</td><td>The title of the table </td></tr> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to create </td></tr> + <tr><td class="paramname">nfields</td><td>The number of fields </td></tr> + <tr><td class="paramname">nrecords</td><td>The number of records </td></tr> + <tr><td class="paramname">type_size</td><td>The size in bytes of the structure associated with the table; This value is obtained with sizeof(). </td></tr> + <tr><td class="paramname">field_names</td><td>An array containing the names of the fields </td></tr> + <tr><td class="paramname">field_offset</td><td>An array containing the offsets of the fields </td></tr> + <tr><td class="paramname">field_types</td><td>An array containing the type of the fields </td></tr> + <tr><td class="paramname">chunk_size</td><td>The chunk size </td></tr> + <tr><td class="paramname">fill_data</td><td>Fill values data </td></tr> + <tr><td class="paramname">compress</td><td>Flag that turns compression on or off </td></tr> + <tr><td class="paramname">data</td><td>Buffer with data to be written to the table </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_t_b.html#gacce384a15825421d1bddfc7b3ab1e7d0">H5TBmake_table()</a> </p> + +</div> +</div> +<a id="ga764a493a6c66fcd0935c0f2f73f0ec4c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga764a493a6c66fcd0935c0f2f73f0ec4c">◆ </a></span>h5tbread_field_index_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine <a class="el" href="interfaceh5tb_1_1h5tbread__field__index__f.html">h5tb::h5tbread_field_index_f</a> </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>field_index</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(in) </td> + <td class="paramname"><em>type_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(type), dimension(*), intent(inout) </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Reads field. The fields are identified by index. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to read. </td></tr> + <tr><td class="paramname">field_index</td><td>The indexes of the fields to read. </td></tr> + <tr><td class="paramname">start</td><td>The start record to read from. </td></tr> + <tr><td class="paramname">nrecords</td><td>The number of records to read. </td></tr> + <tr><td class="paramname">type_size</td><td>The size in bytes of the structure associated with the table. Obtained with sizeof or storage_size. </td></tr> + <tr><td class="paramname">buf</td><td>Buffer with data. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See similar C API: <a class="el" href="group___h5_t_b.html#ga2935a3b52062eb8ba29df6967861cb42">H5TBread_fields_index()</a> </p> + +</div> +</div> +<a id="gac5f0be340f1d9640d39bcf1c026f3cb0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac5f0be340f1d9640d39bcf1c026f3cb0">◆ </a></span>h5tbread_field_name_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine <a class="el" href="interfaceh5tb_1_1h5tbread__field__name__f.html">h5tb::h5tbread_field_name_f</a> </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>field_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(in) </td> + <td class="paramname"><em>type_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(type), dimension(*), intent(inout) </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Reads one or several fields. The fields are identified by name. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to read. </td></tr> + <tr><td class="paramname">field_name</td><td>An array containing the names of the fields to read. </td></tr> + <tr><td class="paramname">start</td><td>The start record to read from. </td></tr> + <tr><td class="paramname">nrecords</td><td>The number of records to read. </td></tr> + <tr><td class="paramname">type_size</td><td>The size in bytes of the structure associated with the table. Obtained with sizeof or storage_size. </td></tr> + <tr><td class="paramname">buf</td><td>Buffer with data </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See similar C API: <a class="el" href="group___h5_t_b.html#gae5034ff895197afa3e21744cfc91ef4b">H5TBread_fields_name()</a> </p> + +</div> +</div> +<a id="ga5a1728f6a51879b96b2fcb72c133a1f6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5a1728f6a51879b96b2fcb72c133a1f6">◆ </a></span>h5tbread_table_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5tb::h5tbread_table_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nfields</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(in) </td> + <td class="paramname"><em>dst_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), dimension(1:nfields), intent(in) </td> + <td class="paramname"><em>dst_offset</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), dimension(1:nfields), intent(in) </td> + <td class="paramname"><em>dst_sizes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(c_ptr) </td> + <td class="paramname"><em>dst_buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Reads a table. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to read </td></tr> + <tr><td class="paramname">nfields</td><td>Number of fields, i.e., size of dst_offset and dst_sizes arrays. </td></tr> + <tr><td class="paramname">dst_size</td><td>The size of the structure type, as calculated by sizeof or storage_size </td></tr> + <tr><td class="paramname">dst_offset</td><td>An array containing the offsets of the fields. These offsets can be calculated with H5OFFSETOF. </td></tr> + <tr><td class="paramname">dst_sizes</td><td>An array containing the sizes of the fields. These sizes can be calculated with sizeof or storage_size. </td></tr> + <tr><td class="paramname">dst_buf</td><td>Pointer to buffer with data. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_t_b.html#gae3f29b60e32a09a4d6c7bae56374a3bb">H5TBread_table()</a> </p> + +</div> +</div> +<a id="ga336066162f632fcfb5880a90d94a26bf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga336066162f632fcfb5880a90d94a26bf">◆ </a></span>h5tbwrite_field_index_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine <a class="el" href="interfaceh5tb_1_1h5tbwrite__field__index__f.html">h5tb::h5tbwrite_field_index_f</a> </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>field_index</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(in) </td> + <td class="paramname"><em>type_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, dimension(*), intent(in) </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Overwrites a field. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to overwrite. </td></tr> + <tr><td class="paramname">field_index</td><td>The indexe of the fields to write. </td></tr> + <tr><td class="paramname">start</td><td>The zero based index record to start writing. </td></tr> + <tr><td class="paramname">nrecords</td><td>The number of records to write. </td></tr> + <tr><td class="paramname">type_size</td><td>The size of the structure type, as calculated by sizeof or storage_size. </td></tr> + <tr><td class="paramname">buf</td><td>Buffer with data. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See similar C API: <a class="el" href="group___h5_t_b.html#ga820da7b5da9a59495df6557e6f24f9b3">H5TBwrite_fields_index()</a> </p> + +</div> +</div> +<a id="gad5affc92b1409825d7b28c2fc7f6da9c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad5affc92b1409825d7b28c2fc7f6da9c">◆ </a></span>h5tbwrite_field_name_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine <a class="el" href="interfaceh5tb_1_1h5tbwrite__field__name__f.html">h5tb::h5tbwrite_field_name_f</a> </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>field_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>nrecords</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(in) </td> + <td class="paramname"><em>type_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">type(type), dimension(*), intent(in) </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Overwrites field. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to overwrite </td></tr> + <tr><td class="paramname">field_name</td><td>The names of the fields to write </td></tr> + <tr><td class="paramname">start</td><td>The zero index record to start writing </td></tr> + <tr><td class="paramname">nrecords</td><td>The number of records to write </td></tr> + <tr><td class="paramname">type_size</td><td>The size of the structure type, as calculated by sizeof or storage_size. </td></tr> + <tr><td class="paramname">buf</td><td>Buffer with data. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See similar C API: <a class="el" href="group___h5_t_b.html#ga0e83a9cd682f3d1f499d20e58aa61111">H5TBwrite_fields_name()</a> </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 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> |