summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorElena Pourmal <epourmal@hdfgroup.org>2002-10-01 18:55:47 (GMT)
committerElena Pourmal <epourmal@hdfgroup.org>2002-10-01 18:55:47 (GMT)
commit01a577a4e90c6fcd66888e69705292cd57232da8 (patch)
treeb5e5eeb79887d20a98b397f3a13d05dfa5573202 /doc
parent09325c1da67ed0b747b70951f1e373ddd42f9478 (diff)
downloadhdf5-01a577a4e90c6fcd66888e69705292cd57232da8.zip
hdf5-01a577a4e90c6fcd66888e69705292cd57232da8.tar.gz
hdf5-01a577a4e90c6fcd66888e69705292cd57232da8.tar.bz2
[svn-r5956]
Purpose: Added new F90 APIs Description: I added new F90 APIs, tests, and documentation for the following functions: h5fget_obj_count_f h5pequal_f h5tget_member_index_f h5fget_obj_ids_f h5pget_fclose_degree_f h5pset_fclose_degree_f Documentation for exisiting functions was missing: h5freopen_f, h5fflush_f, h5fmount_f, h5unmount_f, h5fget_create_plist_f, h5fget_access_plist_f. Platforms tested: Solaris 2.7, Linux 2.2 and IRIX64-6.5
Diffstat (limited to 'doc')
-rw-r--r--doc/html/fortran/h5f_FORTRAN.html189
-rw-r--r--doc/html/fortran/h5p_FORTRAN.html79
-rw-r--r--doc/html/fortran/h5t_FORTRAN.html25
3 files changed, 291 insertions, 2 deletions
diff --git a/doc/html/fortran/h5f_FORTRAN.html b/doc/html/fortran/h5f_FORTRAN.html
index 59228ab..65dec4e 100644
--- a/doc/html/fortran/h5f_FORTRAN.html
+++ b/doc/html/fortran/h5f_FORTRAN.html
@@ -128,6 +128,193 @@ FORTRAN File API -- h5f
</pre>
+<p>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5freopen_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <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>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5fflush_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <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>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5fmount_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <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>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5funmount_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <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>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5fget_create_plist_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <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>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5fget_access_plist_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <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>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5fget_obj_count_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <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>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5fget_obj_ids_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <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>
@@ -141,7 +328,7 @@ FORTRAN File API -- h5f
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
-Last modified: 20 October 1999
+Last modified: 30 September, 2002
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch
diff --git a/doc/html/fortran/h5p_FORTRAN.html b/doc/html/fortran/h5p_FORTRAN.html
index cac1b43..b2d1aa7 100644
--- a/doc/html/fortran/h5p_FORTRAN.html
+++ b/doc/html/fortran/h5p_FORTRAN.html
@@ -1317,6 +1317,83 @@ FORTRAN Property List API -- h5p
</pre>
+<p>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5pget_fclose_degree_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pget_fclose_degree_f</strong>
+<pre>
+
+ SUBROUTINE h5pget_fclose_degree_f(fapl_id, degree, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: fapl_id ! File access property list identifier
+ INTEGER, INTENT(OUT) :: degree ! Info about file close behavior,
+ ! possible values:
+ ! H5F_CLOSE_DEFAULT_F
+ ! H5F_CLOSE_WEAK_F
+ ! H5F_CLOSE_SEMI_F
+ ! H5F_CLOSE_STRONG_F
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ END SUBROUTINE h5pget_fclose_degree_f
+</pre>
+
+
+<p>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5pset_fclose_degree_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pset_fclose_degree_f</strong>
+<pre>
+
+ SUBROUTINE h5pset_fclose_degree_f(fapl_id, degree, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: fapl_id ! File access property list identifier
+ INTEGER, INTENT(IN) :: degree ! Info about file close behavior,
+ ! possible values:
+ ! H5F_CLOSE_DEFAULT_F
+ ! H5F_CLOSE_WEAK_F
+ ! H5F_CLOSE_SEMI_F
+ ! H5F_CLOSE_STRONG_F
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ END SUBROUTINE h5pset_fclose_degree_f
+
+</pre>
+
+
+<p>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5pequal_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5peqaul_f</strong>
+<pre>
+
+ SUBROUTINE h5pequal_f(plist1_id, plist2_id, flag, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: plist1_id ! property list identifier
+ INTEGER(HID_T), INTENT(IN) :: plist2_id ! property list identifier
+ LOGICAL, INTENET(OUT) :: flag ! flag, equals to .TRUE. if
+ ! if lists are equal, otherwise
+ ! equals to .FALSE.
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ END SUBROUTINE h5pequal_f
+
+</pre>
+
</dl>
@@ -1331,7 +1408,7 @@ FORTRAN Property List API -- h5p
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
-Last modified: 21 August 2001
+Last modified: 30 Septemeber, 2002
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch
diff --git a/doc/html/fortran/h5t_FORTRAN.html b/doc/html/fortran/h5t_FORTRAN.html
index d971e9f..02438fa 100644
--- a/doc/html/fortran/h5t_FORTRAN.html
+++ b/doc/html/fortran/h5t_FORTRAN.html
@@ -853,6 +853,31 @@ FORTRAN Datatype API -- h5t
</pre>
+
+<p>&nbsp;
+<p>&nbsp;
+<hr>
+<p>&nbsp;
+<a name="h5tget_member_index_f">
+<p>&nbsp;
+</a>
+
+
+<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5tget_member_index_f</strong>
+<pre>
+
+ SUBROUTINE h5tget_member_index_f(type_id, member_name, index , hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
+ CHARACTER(LEN=*), INTENT(IN) :: member_name !name of a field of
+ !a compound datatype
+ ! or a member of ENUM type
+ INTEGER, INTENT(OUT) :: index !Field index (0-based) of the field name to retrieve
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+
+ END SUBROUTINE h5tget_member_index_f
+</pre>
+
<p>&nbsp;
<p>&nbsp;
<hr>