summaryrefslogtreecommitdiffstats
path: root/doc/html/fortran/h5_FORTRAN.html
blob: 21f58c33e150d824a0c69279bff6f380cb502d6a (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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<html>
<head><title>
FORTRAN General Library API -- h5i
</title>

<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" -->

<!--
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Copyright by the Board of Trustees of the University of Illinois.         *
  * All rights reserved.                                                      *
  *                                                                           *
  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
  * terms governing use, modification, and redistribution, is contained in    *
  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
  * of the source code distribution tree; Copyright.html can be found at the  *
  * root level of an installed copy of the electronic HDF5 document set and   *
  * is linked from the top-level documents page.  It can also be found at     *
  * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
  * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 -->

<link href="../ed_styles/RMelect.css" rel="stylesheet" type="text/css">
<!-- #EndLibraryItem --></head>

<body bgcolor="#FFFFFF">



<center>
<h1>The FORTRAN 90 API to HDF5<br>h5: General Library</h1>
</center>


<dl>


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5open_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong>  &nbsp <strong>h5open_f</strong>

<dt><strong>Purpose:</strong> 
    Initializes the HDF5 library and the Fortran90 interface.

<pre>
          SUBROUTINE h5open_f(hdferr) 
            IMPLICIT NONE
            INTEGER, INTENT(OUT) :: hdferr      ! Error code

          END SUBROUTINE h5open_f
</pre>


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5close_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong>  &nbsp <strong>h5close_f</strong>

<dt><strong>Purpose:</strong> 
    Closes the HDF5 library and the Fortran90 interface.

<pre>
          SUBROUTINE h5close_f(hdferr) 
            IMPLICIT NONE
            INTEGER, INTENT(OUT) :: hdferr      ! Error code

          END SUBROUTINE h5close_f
</pre>


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5garbage_collect_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong>  &nbsp <strong>h5garbage_collect_f</strong>

<dt><strong>Purpose:</strong> 
    Garbage collects on all free-lists of all types

<pre>
          SUBROUTINE h5garbage_collect_f(hdferr) 
            IMPLICIT NONE
            INTEGER, INTENT(OUT) :: hdferr      ! Error code

          END SUBROUTINE h5garbage_collect_f
</pre>

</dl>


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5dont_atexit_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong>  &nbsp <strong>h5dont_atexit_f</strong>

<dt><strong>Purpose:</strong> 
    Instructs library not to install atexit cleanup routine. 

<pre>
          SUBROUTINE h5dont_atexit_f(hdferr) 
            IMPLICIT NONE
            INTEGER, INTENT(OUT) :: hdferr      ! Error code

          END SUBROUTINE h5dont_atexit_f
</pre>


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5get_libversion_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong>  &nbsp <strong>h5get_libversion_f</strong>

<dt><strong>Purpose:</strong> 
    Returns the HDF5 library version and release numbers. 

<pre>
          SUBROUTINE h5get_libversion_f(hdferr) 
            IMPLICIT NONE
            INTEGER, INTENT(OUT) :: majnum      ! The major version of the library
            INTEGER, INTENT(OUT) :: minnum      ! The minor version of the library
            INTEGER, INTENT(OUT) :: relnum      ! The release number 
            INTEGER, INTENT(OUT) :: hdferr      ! Error code

          END SUBROUTINE h5get_libversion_f
</pre>


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5check_version_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong>  &nbsp <strong>h5check_version_f</strong>

<dt><strong>Purpose:</strong> 
    Verifies that library versions are consistent. 

<pre>
          SUBROUTINE h5check_version_f(hdferr) 
            IMPLICIT NONE
            INTEGER, INTENT(IN)  :: majnum      ! The major version of the library
            INTEGER, INTENT(IN)  :: minnum      ! The minor version of the library
            INTEGER, INTENT(IN)  :: relnum      ! The release number 
            INTEGER, INTENT(OUT) :: hdferr      ! Error code

          END SUBROUTINE h5check_version_f
</pre>

<p>&nbsp;
<p>&nbsp;
<hr>


<!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> 
<br>
Describes HDF5 Release 1.6.0, July 2003
</address><!-- #EndLibraryItem --><dt>

Last modified:  24 September, 2002

</body>
</html>