summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5F.html
blob: 738453258b1d22605a2aad769c17974efae6f879 (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
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
<html>
<head><title>
HDF5/H5F 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>&nbsp;<br>
<a href="H5.user.html">HDF5 User Guide</a>&nbsp;<br>
<a href="index.html">Other HDF5 documents and links</a>&nbsp;<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>&nbsp;&nbsp;
<br>
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
H5F&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
<a href="RM_H5I.html">H5I</a>&nbsp;&nbsp;
<br>
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
<a href="RM_H5RA.html">H5RA</a>&nbsp;&nbsp;
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
</td></tr>
</table>
</center>
<hr>


<center>
<h1>H5F: File Interface</h1>
</center>

<h2>File API Functions</h2>

These functions are designed to provide file-level access to HDF5 files.
Further manipulation of objects inside a file is performed through one of APIs
documented below.

<table border=0>
<tr><td valign=top>
<ul>
    <li><a href="#File-Open">H5Fopen</a>
    <li><a href="#File-Create">H5Fcreate</a>
    <li><a href="#File-IsHDF5">H5Fis_hdf5</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
    <li><a href="#File-Flush">H5Fflush</a>
    <li><a href="#File-Close">H5Fclose</a>
    <li><a href="#File-Mount">H5Fmount</a>
    <li><a href="#File-Unmount">H5Funmount</a>
    <li><a href="#File-Reopen">H5Freopen</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
    <li><a href="#File-GetCreatePlist">H5Fget_create_plist</a>
    <li><a href="#File-GetAccessPlist">H5Fget_access_plist</a>
</ul>
</td></tr>
</table>


<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Open">H5Fopen</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Fopen</code>(<em>const char *</em><code>name</code>,
            <em>unsigned</em> <code>flags</code>,
            <em>hid_t</em> <code>access_id</code>
        )
<dt><strong>Purpose:</strong>
        <dd>Opens an existing file.
<dt><strong>Description:</strong>
        <dd><code>H5Fopen</code> opens an existing file and is the primary 
            function for accessing existing HDF5 files.  
            <p>
            The parameter <code>access_id</code> is a file access property
	      list identifier or <code>H5P_DEFAULT</code> for the default I/O access
            parameters.  
            <p>
            The <code>flags</code> argument determines whether writing 
 		to an existing file will be allowed or not.  
            The file is opened with read and write permission if 
	      <code>flags</code> is set to <code>H5F_ACC_RDWR</code>.  
            All flags may be combined with the bit-wise OR operator (`|') 
 		to change the behavior of the file open call.  
 		The more complex behaviors of a file's access are controlled 
 		through the file-access property list.
            <p>
            Files which are opened more than once return a unique identifier 
            for each <code>H5Fopen()</code> call and can be accessed 
            through all file identifiers.  
            <p>
            The return value is a file identifier for the open file and it
            should be closed by calling <code>H5Fclose()</code> when it is
            no longer needed. 
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>const char *</em><code>name</code>
            <dd>Name of the file to access.
        <dt><em>unsigned</em> <code>flags</code>
            <dd>File access flags.  See the <code>H5Fcreate</code>
                parameters list for a list of possible values.
        <dt><em>hid_t</em> <code>access_id</code>
            <dd>Identifier for the file access properties list.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Returns a file identifier if successful;
        otherwise returns a negative value.
</dl>


<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Create">H5Fcreate</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Fcreate</code>(<em>const char *</em><code>name</code>,
            <em>unsigned</em> <code>flags</code>,
            <em>hid_t</em> <code>create_id</code>,
            <em>hid_t</em> <code>access_id</code>
        )
<dt><strong>Purpose:</strong>
        <dd>Creates HDF5 files.
<dt><strong>Description:</strong>
        <dd><code>H5Fcreate</code> is the primary function for creating 
            HDF5 files . 
            <p>
            The <code>flags</code> parameter determines whether an 
            existing file will be overwritten.  All newly created files 
            are opened for both reading and writing.  All flags may be 
            combined with the bit-wise OR operator (`|') to change 
            the behavior of the <code>H5Fcreate</code> call.
            <p>
            The more complex behaviors of file creation and access
            are controlled through the file-creation and file-access
            property lists.  The value of <code>H5P_DEFAULT</code> for 
            a property list value indicates that the library should use
            the default values for the appropriate property list.  Also see
            <code>H5Fpublic.h</code> for the list of supported flags. 
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>const char *</em><code>name</code>
            <dd>Name of the file to access.
        <dt><em>uintn</em> <code>flags</code>
            <dd>File access flags.  Possible values include:
                <ul><dl>
                    <dt>H5F_ACC_RDWR
                        <dd>Allow read and write access to file.
                    <dt>H5F_ACC_RDONLY
                        <dd>Allow read-only access to file.
                    <dt>H5F_ACC_TRUNC
                        <dd>Truncate file, if it already exists,  
                            erasing all data previously stored in the file.
                    <dt>H5F_ACC_EXCL
                        <dd>Fail if file already exists.
                    <dt>H5F_ACC_DEBUG
                        <dd>Print debug information.
                    <dt>H5P_DEFAULT
                        <dd>Apply default file access and creation properties.
                </dl></ul>
        <dt><em>hid_t</em> <code>create_id</code>
            <dd>File creation property list identifier, used when modifying
                default file meta-data.
        <dt><em>hid_t</em> <code>access_id</code>
            <dd>File access property list identifier.
                If parallel file access is desired, this is a collective
                call according to the communicator stored in the
                <code>access_id</code>. 
                Use <code>0</code> for default access properties.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Returns a file identifier if successful;
        otherwise returns a negative value.
</dl>


<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Flush">H5Fflush</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Fflush</code>(<em>hid_t </em><code>object_id</code>,
        <em>H5F_scope_t</em> <code>scope</code>
        )
<dt><strong>Purpose:</strong>
        <dd>Flushes all buffers associated with a file to disk.
<dt><strong>Description:</strong>
        <dd><code>H5Fflush</code> causes all buffers associated with a
        file to be immediately flushed to disk without removing the
        data from the cache.  
        <p>
        <code>object_id</code> can be any object associated with the file, 
        including the file itself, a dataset, a group, an attribute, or 
        a named data type.
        <p>
        <code>scope</code> specifies whether the scope of the flushing 
        action is global or local.  Valid values are
        <center>
        <table border=0>
        <tr><td align=left valign=bottom><code>H5F_SCOPE_GLOBAL</code></td>
            <td>&nbsp;&nbsp;&nbsp;&nbsp;</td>
            <td align=left valign=bottom>Flushes the entire virtual file.</td></tr>
        <tr><td align=left valign=bottom><code>H5F_SCOPE_LOCAL</code></td>
            <td></td>
            <td align=left valign=bottom>Flushes only the specified file.</td></tr>
        </table>
        </center>       
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>const char *</em><code>object_id</code>
            <dd>Identifier of object used to identify the file.
        <dt><em>H5F_scope_t</em> <code>scope</code>
            <dd>Specifies the scope of the flushing action.
    </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="File-IsHDF5">H5Fis_hdf5</a>
<dt><strong>Signature:</strong>
    <dd><em>hbool_t </em><code>H5Fis_hdf5</code>(<em>const char *</em><code>name</code>
        )
<dt><strong>Purpose:</strong>
        <dd>Determines whether a file is in the HDF5 format.
<dt><strong>Description:</strong>
        <dd><code>H5Fis_hdf5</code> determines whether a file is in 
            the HDF5 format.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>const char *</em><code>name</code>
            <dd>File name to check format.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful.
        Otherwise returns a negative value.
</dl>


<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetCreatePlist">H5Fget_create_plist</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Fget_create_plist</code>(<em>hid_t</em> <code>file_id</code>
        )
<dt><strong>Purpose:</strong>
        <dd>Returns a file creation property list identifier.
<dt><strong>Description:</strong>
        <dd><code>H5Fget_create_plist</code> returns a file creation 
            property list identifier identifying the creation properties 
            used to create this file.  This function is useful for 
            duplicating properties when creating another file.
            <p>
            See "File Creation Properties" in 
            <a href="RM_H5P.html">H5P: Property List Interface</a> 
            in this reference manual and 
            "File Creation Properties" 
            in <a href="Files.html"><cite>Files</cite></a> in the 
            <cite>HDF5 User's Guide</cite> for 
            additional information and related functions.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>file_id</code>
            <dd>Identifier of the file to get creation property list of
    </dl>
<dt><strong>Returns:</strong>
    <dd>Returns a file creation property list identifier if successful;
        otherwise returns a negative value.
</dl>


<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetAccessPlist">H5Fget_access_plist</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Fget_access_plist</code>(<em>hid_t</em> <code>file_id</code>)
<dt><strong>Purpose:</strong>
        <dd>Returns a file access property list identifier.
<dt><strong>Description:</strong>
        <dd><code>H5Fget_access_plist</code> returns the 
            file access property list identifier of the specified file.
            <p>
            See "File Access Properties" in 
            <a href="RM_H5P.html">H5P: Property List Interface</a> 
            in this reference manual and 
            "File Access Property Lists" 
            in <a href="Files.html"><cite>Files</cite></a> in the 
            <cite>HDF5 User's Guide</cite> for 
            additional information and related functions.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>file_id</code>
            <dd>Identifier of file to get access property list of
    </dl>
<dt><strong>Returns:</strong>
    <dd>Returns a file access property list identifier if successful;
        otherwise returns a negative value.
</dl>


<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Close">H5Fclose</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Fclose</code>(<em>hid_t</em> <code>file_id</code>
        )
<dt><strong>Purpose:</strong>
        <dd>Terminates access to an HDF5 file.  
<dt><strong>Description:</strong>
        <dd><code>H5Fclose</code> terminates access to an HDF5 file.  
            If this is the last file identifier open for a file 
            and if access identifiers are still in use, 
            this function will fail.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>file_id</code>
            <dd>Identifier of a file to terminate access to.
    </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="File-Mount">H5Fmount</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Fmount</code>(<em>hid_t</em> <code>loc_id</code>,
            <em>const char *</em><code>name</code>,
            <em>hid_t</em> <code>child_id</code>,
            <em>hid_t</em> <code>plist_id</code>
        )
<dt><strong>Purpose:</strong>
        <dd>Mounts a file.
<dt><strong>Description:</strong>
        <dd><code>H5Fmount</code> mounts the file specified by 
            <code>child_id</code> onto the group specified by 
            <code>loc_id</code> and <code>name</code> using 
            the mount properties <code>plist_id</code>.
            <p>
            Note that <code>loc_id</code> identifies a file or group.
            <code>name</code> then specifies a group relative to <code>loc_id</code>.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>loc_id</code>
            <dd>The identifier for of file or group in 
                which <code>name</code> is defined.
        <dt><em>const char *</em><code>name</code>
            <dd>The name of the group onto which the 
                file specified by <code>child_id</code> 
                is to be mounted.
        <dt><em>hid_t</em> <code>child_id</code>
            <dd>The identifier of the file to be mounted.
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>The identifier of the property list to be used.
    </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="File-Unmount">H5Funmount</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Funmount</code>(<em>hid_t</em> <code>loc_id</code>,
            <em>const char *</em><code>name</code>
        )
<dt><strong>Purpose:</strong>
        <dd>Unmounts a file.
<dt><strong>Description:</strong>
        <dd>Given a mount point, <code>H5Funmount</code> 
            dissassociates the mount point's file
            from the file mounted there.  This function
            does  not close either file.
            <p> 
            The mount point can either be the group in the
            parent or the root group of the mounted file 
            (both groups have the same name).  If the mount 
            point was opened before the mount then it is the 
            group in the parent; if it was opened after the 
            mount then it is the root group of the child.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>loc_id</code>
            <dd>The file or group identifier for the location at which
                the specified file is to be unmounted.
        <dt><em>const char *</em><code>name</code>
            <dd>The name of the file to be unmounted.
    </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="File-Reopen">H5Freopen</a>
<dt><strong>Signature:</strong>
    <dd><em>hid__t </em><code>H5Freopen</code>(<em>hid_t</em> <code>file_id</code>
        )
<dt><strong>Purpose:</strong>
        <dd>Reopens an HDF5 file.
<dt><strong>Description:</strong>
        <dd><code>H5Freopen</code> reopens an HDF5 file.  The new 
            file identifier which is returned points to the same file 
            as the specified file idetifier, <code>file_id</code>.  
            Both identifiers share caches and other information.  
            The only difference between the identifiers is that the 
            new identifier is not mounted anywhere and no files are 
            mounted on it.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>file_id</code>
            <dd>Identifier of a file to terminate access to.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Returns a new file 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>&nbsp;<br>
<a href="H5.user.html">HDF5 User Guide</a>&nbsp;<br>
<a href="index.html">Other HDF5 documents and links</a>&nbsp;<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>&nbsp;&nbsp;
<br>
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
H5F&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
<a href="RM_H5I.html">H5I</a>&nbsp;&nbsp;
<br>
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
<a href="RM_H5RA.html">H5RA</a>&nbsp;&nbsp;
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
</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>