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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-type" content="text/html; charset=ISO-8859-1" />
<link rel="stylesheet" href="../robodoc.css" type="text/css" />
<title>./src/H5Rff_F03.f90</title>
<!-- Source: ./src/H5Rff_F03.f90 -->
</head>
<body>
<div id="logo">
<a name="robo_top_of_doc">HDF5 FORTRAN Developer's Guide</a>
</div> <!-- logo -->
<div id="navigation">
<a class="menuitem" href="../toc_index.html#top">Table of Contents</a>
<a class="menuitem" href="../robo_sourcefiles.html#top">Sourcefiles</a>
<a class="menuitem" href="../masterindex.html#top">Index</a>
<a class="menuitem" href="../robo_functions.html#top">Functions</a>
<a class="menuitem" href="../robo_modules.html#top">Modules</a>
<a class="menuitem" href="../robo_procedures.html#top">Procedures</a>
<a class="menuitem" href="../robo_subroutines.html#top">Subroutines</a>
</div> <!-- navigation -->
<div id="content">
<hr />
<a name="ROBODoc2fH5R2028F0329"></a>
<a name="robo65"></a><h2>H5R (F03)</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_modules.html#robo_top_of_doc">Modules</a> ]</p>
<p class="item_name">NAME</p>
<pre> MODULE H5R_PROVISIONAL
</pre>
<p class="item_name">FILE</p>
<pre> fortran/src/<a href="#robo_top_of_doc">H5Rff_F03.f90</a>
</pre>
<p class="item_name">PURPOSE</p>
<pre> This file contains Fortran 90 and Fortran 2003 interfaces for <a href="./H5Rff_f90.html#robo64">H5R</a> functions.
It contains the same functions as H5Rff_DEPRECIATE.f90 but includes the
Fortran 2003 functions and the interface listings. This file will be compiled
instead of H5Rff_DEPRECIATE.f90 if Fortran 2003 functions are enabled.
</pre>
<p class="item_name">NOTES</p>
<pre> *** IMPORTANT ***
If you add a new <a href="./H5Rff_f90.html#robo64">H5R</a> function you must add the function name to the
Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
This is needed for Windows based operating systems.
</pre>
<hr />
<a name="H5R2028F03292fh5rcreate5fobject5ff"></a>
<a name="robo358"></a><h2>h5rcreate_object_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rcreate_object_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Creates reference to the object
</pre>
<p class="item_name">INPUTS</p>
<pre> loc_id - location identifier
name - name of the object at the specified location
</pre>
<p class="item_name">OUTPUTS</p>
<pre> ref - reference to the specified object
hdferr: - error code
Success: 0
Failure: -1
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
August 12, 1999
</pre>
<p class="item_name">HISTORY</p>
<pre> Explicit Fortran interfaces were added for
called C functions (it is needed for Windows
port). February 28, 2001
</pre>
<p class="item_name">NOTES</p>
<pre> This is a module procedure for the h5rcreate_f subroutine.
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5rcreate_object_f</strong><span class="sign">(</span>loc_id<span class="sign">,</span> name<span class="sign">,</span> ref<span class="sign">,</span> hdferr<span class="sign">)</span>
USE<span class="sign">,</span> INTRINSIC <span class="sign">:</span><span class="sign">:</span> ISO_C_BINDING
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> loc_id <span class="sign">!</span> Location identifier
CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of the object at location specified
<span class="sign">!</span> by loc_id identifier
TYPE<span class="sign">(</span>hobj_ref_t_f<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>INOUT<span class="sign">)</span><span class="sign">,</span> TARGET <span class="sign">:</span><span class="sign">:</span> ref <span class="sign">!</span> Object reference
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5R2028F03292fh5rcreate5fptr5ff"></a>
<a name="robo360"></a><h2>h5rcreate_ptr_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rcreate_ptr_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Creates a reference.
</pre>
<p class="item_name">INPUTS</p>
<pre> loc_id - location identifier
name - name of the dataset at the specified location
ref_type - type of reference:
H5R_OBJECT
H5T_STD_REF_DSETREG
</pre>
<p class="item_name">OUTPUTS</p>
<pre> ref - reference created by the function call.
hdferr - error code
Success: 0
Failure: -1
OPTIONAL
space_id - dataspace identifier that describes selected region
</pre>
<p class="item_name">AUTHOR</p>
<pre> M. Scot Breitenfeld
June 20, 2008
</pre>
<p class="item_name">NOTES</p>
<pre> This is a module procedure for the h5rcreate_f
subroutine where the output is a pointer.
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5rcreate_ptr_f</strong><span class="sign">(</span>loc_id<span class="sign">,</span> name<span class="sign">,</span> ref_type<span class="sign">,</span> ref<span class="sign">,</span> hdferr<span class="sign">,</span> space_id<span class="sign">)</span>
USE<span class="sign">,</span> INTRINSIC <span class="sign">:</span><span class="sign">:</span> ISO_C_BINDING
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> loc_id <span class="sign">!</span> Location identifier
CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of the dataset at location specified
<span class="sign">!</span> by loc_id identifier
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref_type <span class="sign">!</span> type of reference
TYPE<span class="sign">(</span>C_PTR<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>INOUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref <span class="sign">!</span> Reference created by the function call
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span><span class="sign">,</span> OPTIONAL <span class="sign">:</span><span class="sign">:</span> space_id <span class="sign">!</span> Dataset<span class="squote">'s dataspace identifier
</pre>
<hr />
<a name="H5R2028F03292fh5rcreate5fregion5ff"></a>
<a name="robo362"></a><h2>h5rcreate_region_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rcreate_region_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Creates reference to the dataset region
</pre>
<p class="item_name">INPUTS</p>
<pre> loc_id - location identifier
name - name of the dataset at the specified location
space_id - dataspace identifier that describes selected region
</pre>
<p class="item_name">OUTPUTS</p>
<pre> ref - reference to the dataset region
hdferr: - error code
Success: 0
Failure: -1
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
August 12, 1999
</pre>
<p class="item_name">HISTORY</p>
<pre> Explicit Fortran interfaces were added for
called C functions (it is needed for Windows
port). February 28, 2001
</pre>
<p class="item_name">NOTES</p>
<pre> This is a module procedure for the h5rcreate_f subroutine.
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5rcreate_region_f</strong><span class="sign">(</span>loc_id<span class="sign">,</span> name<span class="sign">,</span> space_id<span class="sign">,</span> ref<span class="sign">,</span> hdferr<span class="sign">)</span>
USE<span class="sign">,</span> INTRINSIC <span class="sign">:</span><span class="sign">:</span> ISO_C_BINDING
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> loc_id <span class="sign">!</span> Location identifier
CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of the dataset at location specified
<span class="sign">!</span> by loc_id identifier
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> space_id <span class="sign">!</span> Dataset<span class="squote">'s dataspace identifier
TYPE(hdset_reg_ref_t_f), INTENT(INOUT), TARGET :: ref ! Dataset region reference
INTEGER, INTENT(OUT) :: hdferr ! Error code
</pre>
<hr />
<a name="H5R2028F03292fh5rdereference5fobject5ff"></a>
<a name="robo363"></a><h2>h5rdereference_object_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rdereference_object_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Opens the <a href="./HDF5_f90.html#robo76">HDF5</a> object referenced
</pre>
<p class="item_name">INPUTS</p>
<pre> dset_id - identifier of the dataset containing
reference
ref - reference to open
</pre>
<p class="item_name">OUTPUTS</p>
<pre> obj_id - object_identifier
hdferr: - error code
Success: 0
Failure: -1
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
August 12, 1999
</pre>
<p class="item_name">HISTORY</p>
<pre> Explicit Fortran interfaces were added for
called C functions (it is needed for Windows
port). February 28, 2001
</pre>
<p class="item_name">NOTES</p>
<pre> This is a module procedure for the h5rdereference_f subroutine.
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5rdereference_object_f</strong><span class="sign">(</span>obj_id<span class="sign">,</span> ref<span class="sign">,</span> ref_obj_id<span class="sign">,</span> hdferr<span class="sign">)</span>
USE<span class="sign">,</span> INTRINSIC <span class="sign">:</span><span class="sign">:</span> ISO_C_BINDING
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> obj_id <span class="sign">!</span> Dataset identifier
TYPE<span class="sign">(</span>hobj_ref_t_f<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span><span class="sign">,</span> TARGET <span class="sign">:</span><span class="sign">:</span> ref <span class="sign">!</span> Object reference
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref_obj_id <span class="sign">!</span> Object identifier
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5R2028F03292fh5rdereference5fptr5ff"></a>
<a name="robo365"></a><h2>h5rdereference_ptr_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rdereference_ptr_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Opens the <a href="./HDF5_f90.html#robo76">HDF5</a> object referenced.
</pre>
<p class="item_name">INPUTS</p>
<pre> obj_id - valid identifier for the file containing the
referenced object or any object in that file.
ref_type - the reference type of ref.
ref - Reference to open.
</pre>
<p class="item_name">OUTPUTS</p>
<pre> ref_obj_id - identifier of referenced object
hdferr - error code
Success: 0
Failure: -1
</pre>
<p class="item_name">AUTHOR</p>
<pre> M. Scot Breitenfeld
June 20, 2008
</pre>
<p class="item_name">NOTES</p>
<pre> This is a module procedure for the h5rdereference_f
subroutine using pointers.
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5rdereference_ptr_f</strong><span class="sign">(</span>obj_id<span class="sign">,</span> ref_type<span class="sign">,</span> ref<span class="sign">,</span> ref_obj_id<span class="sign">,</span> hdferr<span class="sign">)</span>
USE<span class="sign">,</span> INTRINSIC <span class="sign">:</span><span class="sign">:</span> ISO_C_BINDING
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> obj_id <span class="sign">!</span> Valid identifier <span class="keyword">for</span> the file containing the
<span class="sign">!</span> referenced object or any object in that file<span class="sign">.</span>
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref_type <span class="sign">!</span> The reference type of ref<span class="sign">.</span>
TYPE<span class="sign">(</span>C_PTR<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref <span class="sign">!</span> Object reference
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref_obj_id
<span class="sign">!</span> Identifier of referenced object
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5R2028F03292fh5rdereference5fregion5ff"></a>
<a name="robo366"></a><h2>h5rdereference_region_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rdereference_region_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Opens the dataset region
</pre>
<p class="item_name">INPUTS</p>
<pre> dset_id - identifier of the dataset containing
reference to teh regions
ref - reference to open
</pre>
<p class="item_name">OUTPUTS</p>
<pre> obj_id - dataspace identifier
hdferr: - error code
Success: 0
Failure: -1
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
August 12, 1999
</pre>
<p class="item_name">HISTORY</p>
<pre> Explicit Fortran interfaces were added for
called C functions (it is needed for Windows
port). February 28, 2001
</pre>
<p class="item_name">NOTES</p>
<pre> This is a module procedure for the h5rdereference_f subroutine.
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5rdereference_region_f</strong><span class="sign">(</span>obj_id<span class="sign">,</span> ref<span class="sign">,</span> ref_obj_id<span class="sign">,</span> hdferr<span class="sign">)</span>
USE<span class="sign">,</span> INTRINSIC <span class="sign">:</span><span class="sign">:</span> ISO_C_BINDING
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> obj_id <span class="sign">!</span> Dataset identifier
TYPE<span class="sign">(</span>hdset_reg_ref_t_f<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span><span class="sign">,</span> TARGET <span class="sign">:</span><span class="sign">:</span> ref <span class="sign">!</span> Object reference
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref_obj_id <span class="sign">!</span> Dataspace identifier
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5R2028F03292fh5rget5fname5fobject5ff"></a>
<a name="robo369"></a><h2>h5rget_name_object_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rget_name_object_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Retrieves a name of a referenced object.
</pre>
<p class="item_name">INPUTS</p>
<pre> loc_id - Identifier for the dataset containing the reference or for the group that dataset is in.
ref - An object or dataset region reference.
</pre>
<p class="item_name">OUTPUTS</p>
<pre> name - A name associated with the referenced object or dataset region.
hdferr: - error code
Success: 0
Failure: -1
</pre>
<p class="item_name">OPTIONAL PARAMETERS</p>
<pre> size - The size of the name buffer.
</pre>
<p class="item_name">AUTHOR</p>
<pre> M. Scot Breitenfeld
March 28, 2008
SOURCES
or for the group that dataset is in.
returning 0 (zero) if no name is associated
with the identifier
</pre>
<hr />
<a name="H5R2028F03292fh5rget5fname5fptr5ff"></a>
<a name="robo370"></a><h2>h5rget_name_ptr_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rget_name_ptr_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Retrieves a name of a referenced object.
</pre>
<p class="item_name">INPUTS</p>
<pre> loc_id - Identifier for the dataset containing the reference or
for the group that dataset is in.
ref_type - Type of reference.
ref - An object or dataset region reference.
</pre>
<p class="item_name">OUTPUTS</p>
<pre> name - A name associated with the referenced object or dataset ptr.
hdferr - error code
Success: 0
Failure: -1
</pre>
<p class="item_name">OPTIONAL PARAMETERS</p>
<pre> size - The size of the name buffer.
</pre>
<p class="item_name">AUTHOR</p>
<pre> M. Scot Breitenfeld
March 28, 2008
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5rget_name_ptr_f</strong><span class="sign">(</span>loc_id<span class="sign">,</span> ref_type<span class="sign">,</span> ref<span class="sign">,</span> name<span class="sign">,</span> hdferr<span class="sign">,</span> size<span class="sign">)</span>
USE<span class="sign">,</span> INTRINSIC <span class="sign">:</span><span class="sign">:</span> ISO_C_BINDING
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> loc_id <span class="sign">!</span> Identifier <span class="keyword">for</span> the dataset containing the reference
<span class="sign">!</span> or <span class="keyword">for</span> the group that dataset is in<span class="sign">.</span>
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref_type <span class="sign">!</span> Type of reference<span class="sign">.</span>
TYPE<span class="sign">(</span>C_PTR<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref <span class="sign">!</span> An object or dataset region reference<span class="sign">.</span>
CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> A name associated with the referenced object or dataset ptr<span class="sign">.</span>
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> OPTIONAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> The size of the name buffer<span class="sign">,</span>
<span class="sign">!</span> returning 0 <span class="sign">(</span>zero<span class="sign">)</span> <span class="keyword">if</span> no name is associated
<span class="sign">!</span> with the identifier
</pre>
<hr />
<a name="H5R2028F03292fh5rget5fname5fregion5ff"></a>
<a name="robo372"></a><h2>h5rget_name_region_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rget_name_region_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Retrieves a name of a dataset region.
</pre>
<p class="item_name">INPUTS</p>
<pre> loc_id - Identifier for the dataset containing the reference or
for the group that dataset is in.
ref - An object or dataset region reference.
</pre>
<p class="item_name">OUTPUTS</p>
<pre> name - A name associated with the referenced object or dataset region.
hdferr - error code
Success: 0
Failure: -1
</pre>
<p class="item_name">OPTIONAL PARAMETERS</p>
<pre> size - The size of the name buffer.
</pre>
<p class="item_name">AUTHOR</p>
<pre> M. Scot Breitenfeld
March 28, 2008
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5rget_name_region_f</strong><span class="sign">(</span>loc_id<span class="sign">,</span> ref<span class="sign">,</span> name<span class="sign">,</span> hdferr<span class="sign">,</span> size<span class="sign">)</span>
USE<span class="sign">,</span> INTRINSIC <span class="sign">:</span><span class="sign">:</span> ISO_C_BINDING
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> loc_id <span class="sign">!</span> Identifier <span class="keyword">for</span> the dataset containing the reference
<span class="sign">!</span> or <span class="keyword">for</span> the group that dataset is in<span class="sign">.</span>
TYPE<span class="sign">(</span>hdset_reg_ref_t_f<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span><span class="sign">,</span> TARGET <span class="sign">:</span><span class="sign">:</span> ref <span class="sign">!</span> Object reference
INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> OPTIONAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> The size of the name buffer<span class="sign">,</span>
<span class="sign">!</span> returning 0 <span class="sign">(</span>zero<span class="sign">)</span> <span class="keyword">if</span> no name is associated with the identifier
CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> A name associated with the referenced object or dataset region<span class="sign">.</span>
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5R2028F03292fh5rget5fobj5ftype5ff"></a>
<a name="robo373"></a><h2>h5rget_obj_type_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo65">H5R (F03)</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5rget_obj_type_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Retrieves the type of object that an object reference points to.
</pre>
<p class="item_name">INPUTS</p>
<pre> loc_id - Identifier for the dataset containing the reference or
for the group that dataset is in.
ref_type - Type of reference to query.
ref - Reference to query.
</pre>
<p class="item_name">OUTPUTS</p>
<pre> obj_type - Type of referenced object.
H5G_UNKNOWN_F (-1)
H5G_LINK_F 0
H5G_GROUP_F 1
H5G_DATASET_F 2
H5G_TYPE_F 3
hdferr - error code
Success: 0
Failure: -1
</pre>
<p class="item_name">AUTHOR</p>
<pre> M. Scot Breitenfeld
Decemeber 17, 2008
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5rget_obj_type_f</strong><span class="sign">(</span>loc_id<span class="sign">,</span> ref_type<span class="sign">,</span> ref<span class="sign">,</span> obj_type<span class="sign">,</span> hdferr<span class="sign">)</span>
USE<span class="sign">,</span> INTRINSIC <span class="sign">:</span><span class="sign">:</span> ISO_C_BINDING
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> loc_id
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref_type
TYPE<span class="sign">(</span>C_PTR<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ref
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> obj_type
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr
</pre>
</div> <!-- content -->
<div id="footer">
<p>Generated from ./src/H5Rff_F03.f90 on Sun Aug 14 2011 22:49:38
</p>
</div> <!-- footer -->
</body>
</html>
|
