Introduction to HDF5 HDF5 User Guide Other HDF5 documents and links |
And in this document, the
HDF5 Reference Manual
H5 H5A H5D H5E H5F H5G H5I H5P H5R H5RA H5S H5T H5Z Tools |
The C Interfaces:
The FORTRAN90 Interfaces:
In general, each FORTRAN90 subroutine performs exactly the same task
as the corresponding C function. The links below go to the C function
descriptions, which serve as general descriptions for both. A button,
under Non-C API(s) at the end of the C function description,
opens an external browser window displaying the FORTRAN90-specific
information. You will probably want to adjust the size and location of
this external window so that both browser windows are visible and to
facilitate moving easily between them.
H5Fopen
(const char *name
,
unsigned flags
,
hid_t access_id
)
H5Fopen
opens an existing file and is the primary
function for accessing existing HDF5 files.
The parameter access_id
is a file access property
list identifier or H5P_DEFAULT
for the default I/O access
parameters.
The flags
argument determines whether writing
to an existing file will be allowed or not.
The file is opened with read and write permission if
flags
is set to H5F_ACC_RDWR
.
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.
Files which are opened more than once return a unique identifier
for each H5Fopen()
call and can be accessed
through all file identifiers.
The return value is a file identifier for the open file and it
should be closed by calling H5Fclose()
when it is
no longer needed.
name
flags
H5F_ACC_RDWR
and H5F_ACC_RDONLY
are mutually exclusive; use exactly one.
H5F_ACC_DEBUG
, prints
debug information. This flag is used only by HDF5 library
developers; it is neither tested nor supported
for use in applications.
access_id
access_id
.
Use H5P_DEFAULT
for default file access properties.
H5Fcreate
(const char *name
,
unsigned flags
,
hid_t create_id
,
hid_t access_id
)
H5Fcreate
is the primary function for creating
HDF5 files .
The flags
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 H5Fcreate
call.
The more complex behaviors of file creation and access
are controlled through the file-creation and file-access
property lists. The value of H5P_DEFAULT
for
a property list value indicates that the library should use
the default values for the appropriate property list.
name
flags
H5F_ACC_TRUNC
and H5F_ACC_EXCL
are mutually exclusive; use exactly one.
H5F_ACC_DEBUG
, prints
debug information. This flag is used only by HDF5 library
developers; it is neither tested nor supported
for use in applications.
create_id
H5P_DEFAULT
for default file creation properties.
access_id
access_id
.
Use H5P_DEFAULT
for default file access properties.
H5Fflush
(hid_t object_id
,
H5F_scope_t scope
)
H5Fflush
causes all buffers associated with a
file to be immediately flushed to disk without removing the
data from the cache.
object_id
can be any object associated with the file,
including the file itself, a dataset, a group, an attribute, or
a named data type.
scope
specifies whether the scope of the flushing
action is global or local. Valid values are
H5F_SCOPE_GLOBAL |
Flushes the entire virtual file. | |
H5F_SCOPE_LOCAL |
Flushes only the specified file. |
object_id
scope
H5Fis_hdf5
(const char *name
)
H5Fis_hdf5
determines whether a file is in
the HDF5 format.
name
TRUE
,
or 0
(zero), for FALSE
.
Otherwise returns a negative value.
H5Fget_create_plist
(hid_t file_id
)
H5Fget_create_plist
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.
See "File Creation Properties" in H5P: Property List Interface in this reference manual and "File Creation Properties" in Files in the HDF5 User's Guide for additional information and related functions.
file_id
H5Fget_access_plist
(hid_t file_id
)
H5Fget_access_plist
returns the
file access property list identifier of the specified file.
See "File Access Properties" in H5P: Property List Interface in this reference manual and "File Access Property Lists" in Files in the HDF5 User's Guide for additional information and related functions.
file_id
H5Fclose
(hid_t file_id
)
H5Fclose
terminates access to an HDF5 file
by flushing all data to storage and terminating access
to the file through file_id
.
If this is the last file identifier open for the file and no other access identifier is open (e.g., a dataset identifier, group identifier, or shared datatype identifier), the file will be fully closed and access will end.
If this is the last file identifier open for the file and other access identifiers are still in use, those access identifiers remain valid until separately closed and can still be used. (But the file identifier is no longer valid and cannot be used.) Once all of the remaining access identifiers are closed, the file will be fully closed and access will end.
file_id
H5Fmount
(hid_t loc_id
,
const char *name
,
hid_t child_id
,
hid_t plist_id
)
H5Fmount
mounts the file specified by
child_id
onto the group specified by
loc_id
and name
using
the mount properties plist_id
.
Note that loc_id
is either a file or group identifier
and name
is relative to loc_id
.
loc_id
name
is defined.
name
child_id
is to be mounted.
child_id
plist_id
H5Funmount
(hid_t loc_id
,
const char *name
)
H5Funmount
dissassociates the mount point's file
from the file mounted there. This function
does not close either file.
The mount point can be either 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.
Note that loc_id
is either a file or group identifier
and name
is relative to loc_id
.
loc_id
name
H5Freopen
(hid_t file_id
)
H5Freopen
returns a new file identifier for an
already-open HDF5 file, as specified by file_id
.
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.
Note that there is no circumstance under which
H5Freopen
can actually open a closed file;
the file must already be open and have an active
file_id
. E.g., one cannot close a file with
H5Fclose (file_id)
then use
H5Freopen (file_id)
to reopen it.
The new file identifier should be closed by calling
H5Fclose()
when it is no longer needed.
file_id
Introduction to HDF5 HDF5 User Guide Other HDF5 documents and links |
And in this document, the
HDF5 Reference Manual
H5 H5A H5D H5E H5F H5G H5I H5P H5R H5RA H5S H5T H5Z Tools |