Files
hdf5/develop/struct_input.html
T
2026-08-08 00:57:16 +00:00

451 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: Input Struct Reference</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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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">
$(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.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>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Help us improve by taking our short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<!-- ... other metadata & script includes ... -->
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
<script type="text/javascript">
DoxygenAwesomeTabs.init()
</script>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-57FMZK4S7X"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-57FMZK4S7X');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign">
<div id="projectname">HDF5<span id="projectnumber">&#160;Last Updated on 2026-08-08</span>
</div>
<div id="projectbrief">The HDF5 Field Guide</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<div id="main-nav">
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="_getting_started.html"><span>Getting&#160;started</span></a></li>
<li><a href="_u_g.html"><span>User&#160;Guide</span></a></li>
<li><a href="_r_m.html"><span>Reference&#160;Manual</span></a></li>
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
<li><a href="_t_n.html"><span>Technical&#160;Notes</span></a></li>
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
<li><a href="_f_t_s.html"><span>Full-Text&#160;Search</span></a></li>
<li><a href="_about.html"><span>About</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="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()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- main-nav -->
</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">
$(function(){initNavTree('struct_input.html','',''); });
</script>
<div id="container">
<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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">Input Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;tools/src/h5import/h5import.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ad89d8963b1c1ae254ae8895f06e31e60" id="r_ad89d8963b1c1ae254ae8895f06e31e60"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#ad89d8963b1c1ae254ae8895f06e31e60">compressionParam</a></td></tr>
<tr class="memitem:a4028da21a1642bedb57aff6e6fe214c5" id="r_a4028da21a1642bedb57aff6e6fe214c5"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#a4028da21a1642bedb57aff6e6fe214c5">compressionType</a></td></tr>
<tr class="memitem:a5cdd32c6637ce4e379b9c61899c726c3" id="r_a5cdd32c6637ce4e379b9c61899c726c3"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#a5cdd32c6637ce4e379b9c61899c726c3">configOptionVector</a> [15]</td></tr>
<tr class="memitem:a735984d41155bc1032e09bece8f8d66d" id="r_a735984d41155bc1032e09bece8f8d66d"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#a735984d41155bc1032e09bece8f8d66d">data</a></td></tr>
<tr class="memitem:a6e4c703e56e15a69f346808c3eb1c3b0" id="r_a6e4c703e56e15a69f346808c3eb1c3b0"><td class="memItemLeft">char *&#160;</td><td class="memItemRight"><a class="el" href="#a6e4c703e56e15a69f346808c3eb1c3b0">externFilename</a></td></tr>
<tr class="memitem:afc20a92876050507693842f997e429b3" id="r_afc20a92876050507693842f997e429b3"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#afc20a92876050507693842f997e429b3">h5dumpInput</a></td></tr>
<tr class="memitem:a413594a7316bf07c8dde31441ce85e04" id="r_a413594a7316bf07c8dde31441ce85e04"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#a413594a7316bf07c8dde31441ce85e04">inputArchitecture</a></td></tr>
<tr class="memitem:ad692ef14686fbcd8f927f2d2a5d0fe5d" id="r_ad692ef14686fbcd8f927f2d2a5d0fe5d"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#ad692ef14686fbcd8f927f2d2a5d0fe5d">inputByteOrder</a></td></tr>
<tr class="memitem:a1518864502fdc2f71c6895211954c64c" id="r_a1518864502fdc2f71c6895211954c64c"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#a1518864502fdc2f71c6895211954c64c">inputClass</a></td></tr>
<tr class="memitem:ad255f675bdb1dcbda2160670f9912985" id="r_ad255f675bdb1dcbda2160670f9912985"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#ad255f675bdb1dcbda2160670f9912985">inputSize</a></td></tr>
<tr class="memitem:a585c4d52ac63fff3efa4cdcc97805579" id="r_a585c4d52ac63fff3efa4cdcc97805579"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *&#160;</td><td class="memItemRight"><a class="el" href="#a585c4d52ac63fff3efa4cdcc97805579">maxsizeOfDimension</a></td></tr>
<tr class="memitem:a149840d2391b90d452b29765d222d708" id="r_a149840d2391b90d452b29765d222d708"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#a149840d2391b90d452b29765d222d708">outputArchitecture</a></td></tr>
<tr class="memitem:ac19ee206494cb3bff1a88efd03b91330" id="r_ac19ee206494cb3bff1a88efd03b91330"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#ac19ee206494cb3bff1a88efd03b91330">outputByteOrder</a></td></tr>
<tr class="memitem:ae0d94647f51371954dd75743a65044d7" id="r_ae0d94647f51371954dd75743a65044d7"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#ae0d94647f51371954dd75743a65044d7">outputClass</a></td></tr>
<tr class="memitem:aacc2a6dd5ecc20dea8faa4a82e69cf08" id="r_aacc2a6dd5ecc20dea8faa4a82e69cf08"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#aacc2a6dd5ecc20dea8faa4a82e69cf08">outputSize</a></td></tr>
<tr class="memitem:afe013a125600d67569ff154e0a018092" id="r_afe013a125600d67569ff154e0a018092"><td class="memItemLeft">struct <a class="el" href="structpath__info.html">path_info</a>&#160;</td><td class="memItemRight"><a class="el" href="#afe013a125600d67569ff154e0a018092">path</a></td></tr>
<tr class="memitem:a6cfd95afd0afebd625b889fb6e58371c" id="r_a6cfd95afd0afebd625b889fb6e58371c"><td class="memItemLeft">int&#160;</td><td class="memItemRight"><a class="el" href="#a6cfd95afd0afebd625b889fb6e58371c">rank</a></td></tr>
<tr class="memitem:a91795d337efb7e8ebf2b8e3cab8e23e1" id="r_a91795d337efb7e8ebf2b8e3cab8e23e1"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *&#160;</td><td class="memItemRight"><a class="el" href="#a91795d337efb7e8ebf2b8e3cab8e23e1">sizeOfChunk</a></td></tr>
<tr class="memitem:ae8a02f8ed4397c49f527ae4252793f23" id="r_ae8a02f8ed4397c49f527ae4252793f23"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *&#160;</td><td class="memItemRight"><a class="el" href="#ae8a02f8ed4397c49f527ae4252793f23">sizeOfDimension</a></td></tr>
</table>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="ad89d8963b1c1ae254ae8895f06e31e60" name="ad89d8963b1c1ae254ae8895f06e31e60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad89d8963b1c1ae254ae8895f06e31e60">&#9670;&#160;</a></span>compressionParam</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int compressionParam</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4028da21a1642bedb57aff6e6fe214c5" name="a4028da21a1642bedb57aff6e6fe214c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4028da21a1642bedb57aff6e6fe214c5">&#9670;&#160;</a></span>compressionType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int compressionType</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5cdd32c6637ce4e379b9c61899c726c3" name="a5cdd32c6637ce4e379b9c61899c726c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cdd32c6637ce4e379b9c61899c726c3">&#9670;&#160;</a></span>configOptionVector</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int configOptionVector[15]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a735984d41155bc1032e09bece8f8d66d" name="a735984d41155bc1032e09bece8f8d66d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a735984d41155bc1032e09bece8f8d66d">&#9670;&#160;</a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* data</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6e4c703e56e15a69f346808c3eb1c3b0" name="a6e4c703e56e15a69f346808c3eb1c3b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e4c703e56e15a69f346808c3eb1c3b0">&#9670;&#160;</a></span>externFilename</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* externFilename</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afc20a92876050507693842f997e429b3" name="afc20a92876050507693842f997e429b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc20a92876050507693842f997e429b3">&#9670;&#160;</a></span>h5dumpInput</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int h5dumpInput</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a413594a7316bf07c8dde31441ce85e04" name="a413594a7316bf07c8dde31441ce85e04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a413594a7316bf07c8dde31441ce85e04">&#9670;&#160;</a></span>inputArchitecture</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int inputArchitecture</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad692ef14686fbcd8f927f2d2a5d0fe5d" name="ad692ef14686fbcd8f927f2d2a5d0fe5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad692ef14686fbcd8f927f2d2a5d0fe5d">&#9670;&#160;</a></span>inputByteOrder</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int inputByteOrder</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1518864502fdc2f71c6895211954c64c" name="a1518864502fdc2f71c6895211954c64c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1518864502fdc2f71c6895211954c64c">&#9670;&#160;</a></span>inputClass</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int inputClass</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad255f675bdb1dcbda2160670f9912985" name="ad255f675bdb1dcbda2160670f9912985"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad255f675bdb1dcbda2160670f9912985">&#9670;&#160;</a></span>inputSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int inputSize</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a585c4d52ac63fff3efa4cdcc97805579" name="a585c4d52ac63fff3efa4cdcc97805579"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a585c4d52ac63fff3efa4cdcc97805579">&#9670;&#160;</a></span>maxsizeOfDimension</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>* maxsizeOfDimension</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a149840d2391b90d452b29765d222d708" name="a149840d2391b90d452b29765d222d708"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a149840d2391b90d452b29765d222d708">&#9670;&#160;</a></span>outputArchitecture</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int outputArchitecture</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac19ee206494cb3bff1a88efd03b91330" name="ac19ee206494cb3bff1a88efd03b91330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac19ee206494cb3bff1a88efd03b91330">&#9670;&#160;</a></span>outputByteOrder</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int outputByteOrder</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae0d94647f51371954dd75743a65044d7" name="ae0d94647f51371954dd75743a65044d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0d94647f51371954dd75743a65044d7">&#9670;&#160;</a></span>outputClass</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int outputClass</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aacc2a6dd5ecc20dea8faa4a82e69cf08" name="aacc2a6dd5ecc20dea8faa4a82e69cf08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacc2a6dd5ecc20dea8faa4a82e69cf08">&#9670;&#160;</a></span>outputSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int outputSize</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afe013a125600d67569ff154e0a018092" name="afe013a125600d67569ff154e0a018092"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe013a125600d67569ff154e0a018092">&#9670;&#160;</a></span>path</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structpath__info.html">path_info</a> path</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6cfd95afd0afebd625b889fb6e58371c" name="a6cfd95afd0afebd625b889fb6e58371c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cfd95afd0afebd625b889fb6e58371c">&#9670;&#160;</a></span>rank</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rank</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a91795d337efb7e8ebf2b8e3cab8e23e1" name="a91795d337efb7e8ebf2b8e3cab8e23e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91795d337efb7e8ebf2b8e3cab8e23e1">&#9670;&#160;</a></span>sizeOfChunk</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>* sizeOfChunk</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae8a02f8ed4397c49f527ae4252793f23" name="ae8a02f8ed4397c49f527ae4252793f23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8a02f8ed4397c49f527ae4252793f23">&#9670;&#160;</a></span>sizeOfDimension</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>* sizeOfDimension</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>tools/src/h5import/<a class="el" href="h5import_8h.html">h5import.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="struct_input.html">Input</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>