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
|
<html>
<head><title>
HDF5/H5R API Specification
</title></head>
<body bgcolor="#FFFFFF">
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="H5.user.html">HDF5 User Guide</a> <br>
<a href="index.html">Other HDF5 documents and links</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<br>
<a href="RM_H5P.html">H5P</a>
H5R
<a href="RM_H5RA.html">H5RA</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<a href="Tools.html">Tools</a>
</td></tr>
</table>
</center>
<hr>
<center>
<h1>H5R: Reference Interface</h1>
</center>
<h2>Reference API Functions</h2>
The Reference interface allows the user to create references
to specific objects and data regions in an HDF5 file.
<p>
<table border=0 width=98%>
<tr><td valign=top width=33%>
<ul>
<li><a href="#Reference-Create">H5Rcreate</a>
</ul>
</td><td valign=top width=33%>
<ul>
<li><a href="#Reference-Dereference">H5Rdereference</a>
</ul>
</td><td valign=top width=34%>
<ul>
<li><a href="#Reference-GetRegion">H5Rget_region</a>
</ul>
</td></tr>
</table>
<p>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Reference-Create">H5Rcreate</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Rcreate</code>(<em>void *</em><code>ref</code>,
<em>hid_t</em> <code>loc_id</code>,
<em>const char *</em><code>name</code>,
<em>H5R_type_t</em> <code>ref_type</code>,
<em>hid_t</em> <code>space_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Creates a reference.
<dt><strong>Description:</strong>
<dd><code>H5Rcreate</code> creates the reference, <code>ref</code>,
of the type specified in <code>ref_type</code>, pointing to
the object <code>name</code> located at <code>loc_id</code>.
<p>
The parameters <code>loc_id</code> and <code>name</code> are
used to locate the object.
<p>
The parameter <code>space_id</code> identifies the region
to be pointed to (for dataset region references).
<dt><strong>Parameters:</strong>
<dl>
<dt><em>void *</em><code>ref</code>
<dd>OUT: Reference created by the function call.
<dt><em>hid_t</em> <code>loc_id</code>
<dd>IN: Location identifier used to locate the object being
pointed to.
<dt><em>const char *</em><code>name</code>
<dd>IN: Name of object at location <code>loc_id</code>.
<dt><em>H5R_type_t</em> <code>ref_type</code>
<dd>IN: Type of reference.
<dt><em>hid_t</em> <code>space_id</code>
<dd>IN: Dataspace identifier with selection.
Used for dataset region references.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Reference-Dereference">H5Rdereference</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t</em> <code>H5Rdereference</code>(<em>hid_t</em> <code>dataset</code>,
<em>H5R_type_t</em> <code>ref_type</code>,
<em>void *</em><code>ref</code>
)
<dt><strong>Purpose:</strong>
<dd>Opens the HDF5 object referenced.
<dt><strong>Description:</strong>
<dd>Given a reference to some object, <code>H5Rdereference</code>
opens that object and returns an identifier.
<p>
The parameter <code>ref_type</code> specifies the reference type
of <code>ref</code>. See
<a href="References.html#Reference-RefTypes">Reference Types</a> in
<a href="References.html"><i>References (H5R)</i></a>
for a list of valid reference types.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dataset</code>
<dd>IN: Dataset containing reference object.
<dt><em>H5R_type_t</em> <code>ref_type</code>
<dd>IN: The reference type of <code>ref</code>.
<dt><em>void *</em><code>ref</code>
<dd>IN: Reference to open.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns valid identifier if successful;
otherwise returns a negative value.
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Reference-GetRegion">H5Rget_region</a>
<i>(Not yet implemented.)</i>
<dt><strong>Signature:</strong>
<dd><em>H5S_t</em> <code>H5Rget_region</code>(<em>H5D_t</em> <code>dataset</code>,
<em>H5R_type_t</em> <code>ref_type</code>,
<em>void *</em><code>ref</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves a dataspace with the specified region selected.
<dt><strong>Description:</strong>
<dd>Given a reference to an object <code>ref</code>,
<code>H5Rget_region</code> creates a copy of the dataspace
of the dataset pointed to and defines a selection in the copy
which is the region pointed to.
<p>
The parameter <code>ref_type</code> specifies the reference type
of <code>ref</code>. See
<a href="References.html#Reference-RefTypes">Reference Types</a> in
<a href="References.html"><i>References (H5R)</i></a>
for a list of valid reference types.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dataset</code>,
<dd>IN: Dataset containing reference object.
<dt><em>H5R_type_t</em> <code>ref_type</code>,
<dd>IN: The reference type of <code>ref</code>.
<dt><em>void *</em><code>ref</code>
<dd>IN: Reference to open.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a valid identifier if successful;
otherwise returns a negative value.
</dl>
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="H5.user.html">HDF5 User Guide</a> <br>
<a href="index.html">Other HDF5 documents and links</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<br>
<a href="RM_H5P.html">H5P</a>
H5R
<a href="RM_H5RA.html">H5RA</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<a href="Tools.html">Tools</a>
</td></tr>
</table>
</center>
<hr>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 30 October 1998
</body>
</html>
|
