d586a1adb9
Purpose:
DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of
stylesheets and DW libraries.
Stylesheets -- for consistent format management.
DW libraries -- for managing common elements across documents.
Platforms tested:
IE 5 and 6
Netscape
338 lines
10 KiB
HTML
338 lines
10 KiB
HTML
<html>
|
|
<head><title>
|
|
FORTRAN File API -- h5f
|
|
</title>
|
|
|
|
<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" --><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>h5f: Files</h1>
|
|
</center>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fclose_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fclose_f</strong>
|
|
|
|
<pre>
|
|
SUBROUTINE h5fclose_f(file_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5fclose_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fcreate_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fcreate_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5fcreate_f(name, access_flags, file_id, hdferr, &
|
|
creation_prp, access_prp)
|
|
IMPLICIT NONE
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the file
|
|
INTEGER, INTENT(IN) :: access_flag ! File access flags
|
|
! Possible values are:
|
|
! H5F_ACC_RDWR_F
|
|
! H5F_ACC_RDONLY_F
|
|
! H5F_ACC_TRUNC_F
|
|
! H5F_ACC_EXCL_F
|
|
! H5F_ACC_DEBUG_F
|
|
INTEGER(HID_T), INTENT(OUT) :: file_id ! File identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: creation_prp
|
|
! File creation propertly
|
|
! list identifier, if not
|
|
! specified its value is
|
|
! H5P_DEFAULT_F
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: access_prp
|
|
! File access property list
|
|
! identifier, if not
|
|
! specified its value is
|
|
! H5P_DEFAULT_F
|
|
END SUBROUTINE h5fcreate_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fis_hdf5_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fis_hdf5_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5fis_hdf5_f(name, status, hdferr)
|
|
IMPLICIT NONE
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the file
|
|
LOGICAL, INTENT(OUT) :: status ! This parameter
|
|
! indicates if file is
|
|
! an HDF5 file
|
|
! ( TRUE or FALSE )
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5fis_hdf5_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fopen_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fopen_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5fopen_f(name, access_flags, file_id, hdferr, &
|
|
access_prp)
|
|
IMPLICIT NONE
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the file
|
|
INTEGER, INTENT(IN) :: access_flag ! File access flags
|
|
! Possible values are:
|
|
! H5F_ACC_RDWR_F
|
|
! H5F_ACC_RDONLY_F
|
|
INTEGER(HID_T), INTENT(OUT) :: file_id ! File identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: access_prp
|
|
! File access property list
|
|
! identifier
|
|
END SUBROUTINE h5fopen_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5freopen_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5freopen_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5freopen_f(file_id, new_file_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
|
|
INTEGER(HID_T), INTENT(OUT) :: new_file_id ! New file identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5freopen_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fflush_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fflush_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5fflush_f(obj_id, new_file_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
|
|
INTEGER, INTENT(IN) :: scope ! Flag with two possible values:
|
|
! H5F_SCOPE_GLOBAL_F
|
|
! H5F_SCOPE_LOCAL_F
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5fflush_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fmount_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fmount_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5fmount_f(loc_id, name, child_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN):: name ! Group name at locationloc_id
|
|
INTEGER(HID_T), INTENT(IN) :: child_id ! File(to be mounted) identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5fmount_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5funmount_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5funmount_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5funmount_f(loc_id, name, child_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN):: name ! Group name at location loc_id
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5funmount_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fget_create_plist_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fget_create_plist_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5fget_create_plist_f(file_id, fcpl_id, hdferr)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
|
|
INTEGER(HID_T), INTENT(OUT) :: fcpl_id ! File creation property list identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5fget_create_plist_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fget_access_plist_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fget_access_plist_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5fget_access_plist_f(file_id, fcpl_id, hdferr)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
|
|
INTEGER(HID_T), INTENT(OUT) :: fapl_id ! File access property list identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5fget_access_plist_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fget_obj_count_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fget_obj_count_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5fget_obj_count_f(file_id, obj_type, obj_count, hdferr)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
|
|
INTEGER, INTENT(IN) :: obj_type ! Object types, possible values are:
|
|
! H5F_OBJ_FILE_F
|
|
! H5F_OBJ_GROUP_F
|
|
! H5F_OBJ_DATASET_F
|
|
! H5F_OBJ_DATATYPE_F
|
|
! H5F_OBJ_ALL_F
|
|
INTEGER, INTENT(OUT) :: obj_count ! number of opened objects
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5fget_obj_count_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5fget_obj_ids_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5fget_obj_ids_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5fget_obj_ids_f(file_id, obj_type, obj_ids, hdferr)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
|
|
INTEGER, INTENT(IN) :: obj_type ! Object types, possible values are:
|
|
! H5F_OBJ_FILE_F
|
|
! H5F_OBJ_GROUP_F
|
|
! H5F_OBJ_DATASET_F
|
|
! H5F_OBJ_DATATYPE_F
|
|
! H5F_OBJ_ALL_F
|
|
INTEGER(HID_T), DIMENSION(*), INTENT(OUT) :: obj_ids
|
|
! array of requested object identifiers
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5fget_obj_ids_f
|
|
</pre>
|
|
|
|
|
|
</dl>
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
|
|
|
|
<!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
|
|
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
|
<br>
|
|
Describes HDF5 Release 1.5, Unreleased Development Branch
|
|
</address><!-- #EndLibraryItem -->
|
|
|
|
Last modified: 30 September, 2002
|
|
|
|
</body>
|
|
</html>
|