mirror of
https://github.com/HDFGroup/hdf5.git
synced 2024-11-21 01:04:10 +08:00
152 lines
4.5 KiB
HTML
152 lines
4.5 KiB
HTML
<HTML><HEAD>
|
|
<TITLE>The HDF5 API
|
|
</TITLE>
|
|
</HEAD>
|
|
|
|
<body bgcolor="#ffffff">
|
|
|
|
<!-- BEGIN MAIN BODY -->
|
|
|
|
|
|
[ <A HREF="title.html"><I>HDF5 Tutorial Top</I></A> ]
|
|
<H1>
|
|
<BIG><BIG><BIG><FONT COLOR="#c101cd">The HDF5 API</FONT>
|
|
</BIG></BIG></BIG></H1>
|
|
|
|
|
|
<hr noshade size=1>
|
|
|
|
<BODY>
|
|
<P>
|
|
The HDF5 library provides several interfaces, or APIs.
|
|
These APIs provide routines for creating, accessing, and manipulating
|
|
HDF5 files and objects.
|
|
<P>
|
|
The library itself is implemented in C. To facilitate the work of
|
|
FORTRAN90 and Java programmers, HDF5 function wrappers have been developed
|
|
in each of these languages.
|
|
At the time of this writing, a set of C++ wrappers is in development.
|
|
This tutorial discusses the use of the C functions and the FORTRAN wrappers.
|
|
<P>
|
|
All C routines in the HDF5 library begin with a prefix of the form <I>H5</I>*,
|
|
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
|
|
<I>h5</I> and end with <I>_f</I>. The APIs are listed below:
|
|
<P>
|
|
<table width="65%" border="2" cellpadding="4">
|
|
<tr bgcolor="#FFCC99" bordercolor="#FFFFFF">
|
|
<td width="11%">
|
|
<div align="center"><b>API </b></div>
|
|
</td>
|
|
<td width="89%">
|
|
<div align="left"><b>DESCRIPTION</b> </div>
|
|
</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5</b></div>
|
|
</td>
|
|
<td width="89%">Library Functions: general-purpose H5 functions</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5A</b></div>
|
|
</td>
|
|
<td width="89%">Annotation Interface: attribute access and manipulation
|
|
routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5D</b></div>
|
|
</td>
|
|
<td width="89%">Dataset Interface: dataset access and manipulation
|
|
routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5E</b></div>
|
|
</td>
|
|
<td width="89%">Error Interface: error handling routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5F</b></div>
|
|
</td>
|
|
<td width="89%">File Interface: file access routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5G</b></div>
|
|
</td>
|
|
<td width="89%">Group Interface: group creation and operation routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5I</b></div>
|
|
</td>
|
|
<td width="89%">Identifier Interface: identifier routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5P</b></div>
|
|
</td>
|
|
<td width="89%">Property List Interface: object property list manipulation
|
|
routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5R</b></div>
|
|
</td>
|
|
<td width="89%">Reference Interface: reference routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5S</b></div>
|
|
</td>
|
|
<td width="89%">Dataspace Interface: dataspace definition and access
|
|
routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5T</b></div>
|
|
</td>
|
|
<td width="89%">Datatype Interface: datatype creation and manipulation
|
|
routines</td>
|
|
</tr>
|
|
<tr bordercolor="#FFFFFF">
|
|
<td width="11%" bgcolor="#99CCCC">
|
|
<div align="center"><b>H5Z</b></div>
|
|
</td>
|
|
<td width="89%">Compression Interface: compression routine(s)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!-- BEGIN FOOTER INFO -->
|
|
|
|
<P><hr noshade size=1>
|
|
<font face="arial,helvetica" size="-1">
|
|
<a href="http://www.ncsa.uiuc.edu/"><img border=0
|
|
src="footer-ncsalogo.gif"
|
|
width=78 height=27 alt="NCSA"><br>
|
|
The National Center for Supercomputing Applications</A><br>
|
|
<a href="http://www.uiuc.edu/">University of Illinois
|
|
at Urbana-Champaign</a><br>
|
|
<br>
|
|
<!-- <A HREF="helpdesk.mail.html"> -->
|
|
<A HREF="mailto:hdfhelp@ncsa.uiuc.edu">
|
|
hdfhelp@ncsa.uiuc.edu</A>
|
|
<br>
|
|
<BR> <H6>Last Modified: June 22, 2001</H6><BR>
|
|
<!-- modified by Barbara Jones - bljones@ncsa.uiuc.edu -->
|
|
<!-- modified by Frank Baker - fbaker@ncsa.uiuc.edu -->
|
|
</FONT>
|
|
<BR>
|
|
<!-- <A HREF="mailto:hdfhelp@ncsa.uiuc.edu"> -->
|
|
|
|
</BODY>
|
|
</HTML>
|
|
|
|
|
|
|