summaryrefslogtreecommitdiffstats
path: root/doc/html/fortran/h5i_FORTRAN.html
blob: 840781022bea09813f97fd1d19b8745c19f2a2a2 (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
<html>
<head><title>
FORTRAN Identifier 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>h5i: Identifiers</h1>
</center>


<dl>


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


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

<pre>
          SUBROUTINE h5iget_type_f(obj_id, type, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: obj_id  !Object identifier 
            INTEGER, INTENT(OUT) :: type !type of an object. 
                                         !possible values are:
                                         !H5I_FILE_F(1)
                                         !H5I_GROUP_F(2)
                                         !H5I_DATATYPE_F(3)
                                         !H5I_DATASPACE_F(4)
                                         !H5I_DATASET_F(5)
                                         !H5I_ATTR_F(6)
                                         !H5I_BADID_F(-1)
            INTEGER, INTENT(OUT) :: hdferr  ! Error code
                                            ! 0 on success, and -1 on failure

          END SUBROUTINE h5iget_type_f
</pre>


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


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

<pre>
          SUBROUTINE h5iget_name_f(obj_id, buf, buf_size, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN)    :: obj_id     ! Object identifier 
            CHARACTER(LEN=*), INTENT(OUT) :: buf        ! Buffer to hold object name 
            INTEGER(SIZE_T), INTENT(IN)   :: buf_size   ! Buffer size
            INTEGER(SIZE_T), INTENT(OUT)  :: name_size  ! Name size
            INTEGER, INTENT(OUT) :: hdferr              ! Error code
                                                        ! 0 on success, and -1 on failure
                                                     
          END SUBROUTINE h5iget_name_f
</pre>


</dl>

<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 -->

Last modified:  19 March 2003

</body>
</html>