summaryrefslogtreecommitdiffstats
path: root/doc/html/fortran/h5g_FORTRAN.html
blob: 1888c6e52c33fa4e819bce64e11eb64138deb256 (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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
<html>
<head><title>
FORTRAN Group API -- h5g
</title></head>

<body bgcolor="#FFFFFF">



<center>
<h1>The FORTRAN 90 API to HDF5<br>h5g: Groups</h1>
</center>


<dl>


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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gclose_f</code></strong>
<pre>    
         SUBROUTINE h5gclose_f( gr_id, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: gr_id        ! Group identifier
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gclose_f           
</pre>


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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gcreate_f</code></strong>
<pre>    
         SUBROUTINE h5gcreate_f(loc_id, name, gr_id, hdferr, size_hint)

           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group to be created 
           INTEGER(HID_T), INTENT(OUT) :: gr_id       ! Group identifier
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
           INTEGER(SIZE_T), OPTIONAL, INTENT(IN) :: size_hint  
                                       ! Number of bytes to store the names 
                                       ! of objects in the group. 
                                       ! Default value is OBJECT_NAMELEN_DEFAULT_F
         END SUBROUTINE h5gcreate_f           
</pre>


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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gget_comment_f</code></strong>
<pre>    
         SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the object link 
           CHARACTER(LEN=size), INTENT(OUT) :: buffer   ! Buffer to hold a
                                                        ! comment  
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gget_comment_f           
</pre>


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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gget_linkval_f</code></strong>
<pre>    
         SUBROUTINE h5gget_linkval_f(loc_id, name, size, buffer, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the symbolic link 
           CHARACTER(LEN=size), INTENT(OUT) :: buffer   ! Buffer to hold a
                                                        ! name of the object 
                                                        ! symbolic link points to
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gget_linkval_f           
</pre>



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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gget_obj_info_idx_f</code></strong>
<pre>    
          SUBROUTINE h5gget_obj_info_idx_f(loc_id, name, idx, &
                                           obj_name, obj_type, hdferr)
           
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier 
            CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group 
            INTEGER, INTENT(IN) :: idx             ! Index of member object 
            CHARACTER(LEN=*), INTENT(OUT) :: obj_name   ! Name of the object 
            INTEGER, INTENT(OUT) :: obj_type       ! Object type : 
                                                   ! H5G_LINK_F 
                                                   ! H5G_GROUP_F 
                                                   ! H5G_DATASET_F 
                                                   ! H5G_TYPE_F 
            INTEGER, INTENT(OUT) :: hdferr   ! Error code 
                                             ! 0 on success and -1 on failure

          END SUBROUTINE h5gget_obj_info_idx_f
</pre>


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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gmove_f</code></strong>
<pre>    
         SUBROUTINE h5gmove_f(loc_id, name, new_name, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Original name of an object 
           CHARACTER(LEN=*), INTENT(IN) :: new_name   ! New name of an object 
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gmove_f           
</pre>


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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gmove_f</code></strong>
<pre>    
         SUBROUTINE h5gmove2_f(src_loc_id, src_name, dst_loc_id, dst_name, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: src_loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: src_name   ! Original name of an object 
                                                      ! relative to src_loc_id 
           INTEGER(HID_T), INTENT(IN) :: dst_loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: dst_name   ! New name of an object
                                                      ! relative to dst_loc_id 
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gmove2_f           
</pre>


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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gn_members_f</code></strong>
<pre>    
          SUBROUTINE h5gn_members_f(loc_id, name, nmembers, hdferr)
           
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier 
            CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group 
            INTEGER, INTENT(OUT) :: nmembers       ! Number of members in the
                                                   ! group 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code 
                                                 ! 0 on success and -1 on failure

          END SUBROUTINE h5gn_members_f
</pre>


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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gopen_f</code></strong>
<pre>    
         SUBROUTINE h5gopen_f(loc_id, name, gr_id, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group to open 
           INTEGER(HID_T), INTENT(OUT) :: gr_id   ! Group identifier
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gopen_f           
</pre>


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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gset_comment_f</code></strong>
<pre>    
         SUBROUTINE h5gset_comment_f(loc_id, name, comment, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of object 
           CHARACTER(LEN=*), INTENT(IN) :: comment   ! Comment for the object 
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gset_comment_f           
</pre>


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


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

<dt><strong>Purpose:</strong> 
    Creates a link of the specified type from <code> new_name</code> to <code>current_name</code>. 

<pre>
          SUBROUTINE h5glink_f(loc_id, link_type, current_name, new_name, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: loc_id    ! File or group location identifier
            INTEGER, INTENT(IN)        :: link_type ! Link type, possible values are:
                                                    !  H5G_LINK_HARD_F
                                                    !  H5G_LINK_SOFT_F
            CHARACTER(LEN=*), INTENT(IN) :: current_name ! Current object name relative
                                                         ! to loc_id 
            CHARACTER(LEN=*), INTENT(IN) :: new_name     ! New object name 
            INTEGER, INTENT(OUT) :: hdferr          ! Error code

          END SUBROUTINE h5glink_f
</pre>


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


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

<dt><strong>Purpose:</strong> 
    Creates a link of the specified type from <code> new_name</code> at location
<code> new_loc_id,/code> to <code>cur_name</code> at location
<code>cur_loc_id</code>. 

<pre>
          SUBROUTINE h5glink2_f(cur_loc_id, cur_name, link_type, new_loc_id, new_name, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN)   :: cur_loc_id ! File or group location identifier
            CHARACTER(LEN=*), INTENT(IN) :: cur_name
                                           ! Name of the existing object
                                           ! is relative to cur_loc_id. Can be
                                           ! anything for the soft link.
            INTEGER, INTENT(IN) :: link_type ! Link type, possible values are:
                                             !  H5G_LINK_HARD_F
                                             !  H5G_LINK_SOFT_F
            INTEGER(HID_T), INTENT(IN) :: new_loc_id ! New location identifier
            CHARACTER(LEN=*), INTENT(IN) :: new_name ! New object name 
            INTEGER, INTENT(OUT) :: hdferr          ! Error code

          END SUBROUTINE h5glink2_f
</pre>

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


<dt><strong>FORTRAN interface: &nbsp; <code>h5gunlink_f</code></strong>
<pre>    
         SUBROUTINE h5gunlink_f(loc_id, name, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the object to unlink 
           INTEGER, INTENT(OUT) :: hdferr         ! Error code 
                                                  ! 0 on success and -1 on failure
         END SUBROUTINE h5gunlink_f           
</pre>




</dl>

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



<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> 
</address>

Last modified:  20 October 1999
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch


</body>
</html>