summaryrefslogtreecommitdiffstats
path: root/doc/html/Tutor/api.html
blob: 3ed0a848027b6458520ee0d42e287cb72ffcb62f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<HTML><HEAD>
<TITLE>The HDF5 API 
</TITLE> 
</HEAD>

<body bgcolor="#ffffff">

<!-- BEGIN MAIN BODY -->

<A HREF="http://www.ncsa.uiuc.edu/"><img border=0 
src="http://www.ncsa.uiuc.edu/Images/NCSAhome/footerlogo.gif"
width=78 height=27 alt="NCSA"><P></A>

 [ <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, and is currently implemented in
C.  The APIs provide routines for accessing HDF5 files and creating and
manipulating HDF5 objects. All C routines in the HDF5 library begin with
a prefix of the form H5*, where * is a single letter indicating the object on
which the operation is to be performed. 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: the 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 manipulating 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 manipulating 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 creating and operating 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 manipulating 
      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: routines for defining dataspaces.</td>
  </tr>
  <tr bordercolor="#FFFFFF"> 
    <td width="11%" bgcolor="#99CCCC"> 
      <div align="center"><b>H5T</b></div>
    </td>
    <td width="89%">Data type Interface: routines for creating and manipulating 
      the data type of dataset elements.</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="http://www.ncsa.uiuc.edu/Images/NCSAhome/footerlogo.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> <H6>Last Modified: July 30, 1999</H6><BR>
<!-- modified by Barbara Jones - bljones@ncsa.uiuc.edu -->
</FONT>
<BR>
<!-- <A HREF="mailto:hdfhelp@ncsa.uiuc.edu"> -->

</BODY>
</HTML>