mirrors/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2026-09-25 04:09:44 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea9038e9f7cd7df6c71b8035cc765f268600a974
hdf5/develop/_l_b_a_p_i.html
T
byrnHDF ea9038e9f7 deploy: 780f6e40de
2026-09-02 01:23:41 +00:00

197 lines
11 KiB
HTML
Raw Blame History

<!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: The HDF5 API</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-09-02</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('_l_b_a_p_i.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><div class="header">
<div class="headertitle"><div class="title">The HDF5 API </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Navigate back: <a class="el" href="index.html" title="notitle">Main</a> / <a class="el" href="_getting_started.html" title="Getting Started with HDF5">Getting Started with HDF5</a> / <a class="el" href="_learn_basics.html" title="Learning the Basics">Learning the Basics</a> </p><hr />
<h1 class="doxsection"><a class="anchor" id="secLBAPI"></a>
HDF5 C API</h1>
<p>The HDF5 library provides several interfaces, or APIs. These APIs provide routines for creating, accessing, and manipulating HDF5 files and objects.</p>
<p>The library itself is implemented in C. To facilitate the work of FORTRAN 90, C++ and Java programmers, HDF5 function wrappers have been developed in each of these languages. This tutorial discusses the use of the C functions and the FORTRAN wrappers.</p>
<p>All C routines in the HDF5 library begin with a prefix of the form H5*, where * is one or two uppercase letters indicating the type of object on which the function operates. The FORTRAN wrappers come in the form of subroutines that begin with h5 and end with _f. Java routine names begin with “H5*” and are prefixed with “H5.” as the class. Constants are in the HDF5Constants class and are prefixed with "HDF5Constants.". The APIs are listed below: </p><table class="doxtable">
<tr>
<th><b>API</b> </th><th><b>DESCRIPTION</b> </th></tr>
<tr>
<td><b><a class="el" href="_h5__u_g.html" title="HDF5 Library and Programming Model">HDF5 Library and Programming Model</a></b> </td><td>Library Functions: general-purpose <a class="el" href="namespace_h5.html">H5</a> functions </td></tr>
<tr>
<td><b><a class="el" href="_h5_a__u_g.html" title="HDF5 Attributes">HDF5 Attributes</a></b> </td><td>Annotation Interface: attribute access and manipulation routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_d__u_g.html" title="HDF5 Datasets">HDF5 Datasets</a></b> </td><td>Dataset Interface: dataset access and manipulation routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_e__u_g.html" title="HDF5 Error Handling">HDF5 Error Handling</a></b> </td><td>Error Interface: error handling routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_f__u_g.html" title="HDF5 File">HDF5 File</a></b> </td><td>File Interface: file access routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_g__u_g.html" title="HDF5 Groups">HDF5 Groups</a></b> </td><td>Group Interface: group creation and operation routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_i__u_g.html" title="HDF5 Identifiers">HDF5 Identifiers</a></b> </td><td>Identifier Interface: identifier routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_l__u_g.html" title="HDF5 Links">HDF5 Links</a></b> </td><td>Link Interface: link routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_o__u_g.html" title="HDF5 Objects">HDF5 Objects</a></b> </td><td>Object Interface: object routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_p__u_g.html" title="Properties and Property Lists in HDF5">Properties and Property Lists in HDF5</a></b> </td><td>Property List Interface: object property list manipulation routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_r__u_g.html" title="HDF5 References">HDF5 References</a></b> </td><td>Reference Interface: reference routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_s__u_g.html" title="Dataspaces and Partial I/O">Dataspaces and Partial I/O</a></b> </td><td>Dataspace Interface: dataspace definition and access routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_t__u_g.html" title="HDF5 Datatypes">HDF5 Datatypes</a></b> </td><td>Datatype Interface: datatype creation and manipulation routines </td></tr>
<tr>
<td><b><a class="el" href="_h5_z__u_g.html" title="HDF5 Filters">HDF5 Filters</a></b> </td><td>Compression Interface: compression routine(s) </td></tr>
</table>
<hr />
<p> Previous Chapter <a class="el" href="_l_b_file_org.html" title="HDF5 File Organization">HDF5 File Organization</a> - Next Chapter <a class="el" href="_l_b_prog.html" title="Programming Issues">Programming Issues</a></p>
<p>Navigate back: <a class="el" href="index.html" title="notitle">Main</a> / <a class="el" href="_getting_started.html" title="Getting Started with HDF5">Getting Started with HDF5</a> / <a class="el" href="_learn_basics.html" title="Learning the Basics">Learning the Basics</a> </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</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="_learn_basics.html">Learning the Basics</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>
Reference in New Issue View Git Blame Copy Permalink