mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-11-27 02:10:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

[svn-r4094]

Browse Source 
Purpose:
    Synchronizing R1.5 development branch fortran docs
    with R1.4.x release branch.
Platforms tested:
    IE 5
This commit is contained in:
Frank Baker 2001-07-02 13:15:13 -05:00
parent 69b26f8ecb
commit 09390d1fa7
5 changed files with 163 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/html/fortran/h5a_FORTRAN.html
View File

@ -235,14 +235,19 @@ FORTRAN Attribute API -- h5a
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5aread_f</strong>
<pre>
SUBROUTINE h5aread_f(attr_id, memtype_id, buf, hdferr)
SUBROUTINE h5aread_f(attr_id, memtype_id, buf, dims, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: attr_id ! Attribute identifier
INTEGER(HID_T), INTENT(IN) :: memtype_id ! Attribute datatype
! identifier (in memory)
TYPE(VOID), INTENT(OUT) :: buf ! Attribute data
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
TYPE, INTENT(INOUT) :: buf ! Data buffer; may be a scalar or an array
INTEGER, INTENT(IN) :: dims(7) ! Array to hold corresponding
! dimension sizes of data buffer buf;
! dim(k) has value of the k-th dimension
! of buffer buf;
! values are ignored if buf is a scalar
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5aread_f
</pre>
@ -259,12 +264,17 @@ FORTRAN Attribute API -- h5a
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5awrite_f</strong>
<pre>
SUBROUTINE h5awrite_f(attr_id, memtype_id, buf, hdferr)
SUBROUTINE h5awrite_f(attr_id, memtype_id, buf, dims, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: attr_id ! Attribute identifier
INTEGER(HID_T), INTENT(IN) :: memtype_id ! Attribute datatype
! identifier (in memory)
TYPE(VOID), INTENT(IN) :: buf ! Attribute data
TYPE, INTENT(IN) :: buf ! Data buffer; may be a scalar or an array
INTEGER, INTENT(IN) :: dims(7) ! Array to hold corresponding
! dimension sizes of data buffer buf;
! dim(k) has value of the k-th dimension
! of buffer buf;
! values are ignored if buf is a scalar
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5awrite_f
@ -283,10 +293,9 @@ FORTRAN Attribute API -- h5a
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
Last modified: 20 October 1999
Last modified: 29 June 2001
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch
</body>
</html>

88
doc/html/fortran/h5d_FORTRAN.html
View File

@ -162,10 +162,11 @@ FORTRAN Dataset API -- h5d
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5dopen_f</strong>
<pre>
SUBROUTINE h5dopen_f(loc_id, name, hdferr)
SUBROUTINE h5dopen_f(loc_id, name, dset_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the dataset
INTEGER(HID_T), INTENT(OUT) :: dset_id ! Dataset identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5dopen_f
@ -182,15 +183,52 @@ FORTRAN Dataset API -- h5d
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5dread_f</strong>
(for all datatypes except object and dataset region references)
<pre>
SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, hdferr, &
SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, &
mem_space_id, file_space_id, xfer_prp)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier
TYPE, INTENT(IN) :: buf(*,...*) ! Data buffer of rank k
TYPE, INTENT(INOUT) :: buf ! Data buffer; may be a scalar or an array
INTEGER, INTENT(IN) :: dims(7) ! Array to hold corresponding
! dimension sizes of data buffer buf;
! dim(k) has value of the k-th dimension
! of buffer buf;
! values are ignored if buf is a scalar
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id
! Memory dataspace identfier
! Default value is H5S_ALL_F
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id
! File dataspace identfier
! Default value is H5S_ALL_F
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp
! Transfer property list identifier
! Default value is H5P_DEFAULT_F
END SUBROUTINE h5dread_f
</pre>
<p>&nbsp;
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5dread_f</strong>
(for object reference and dataset region reference datatypes)
<pre>
SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, n, hdferr, &
mem_space_id, file_space_id, xfer_prp)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier
TYPE, INTENT(INOUT) :: buf(*) ! Data buffer of rank 1
TYPE, INTENT(IN) :: n ! Buffer size, 1 dimension only
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id
@ -217,15 +255,52 @@ FORTRAN Dataset API -- h5d
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5dwrite_f</strong>
(for all datatypes except object and dataset region references)
<pre>
SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, hdferr, &
SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, &
mem_space_id, file_space_id, xfer_prp)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier
TYPE, INTENT(IN) :: buf(*,...*) ! Data buffer of rank k
TYPE, INTENT(IN) :: buf ! Data buffer; may be a scalar or an array
INTEGER, INTENT(IN) :: dims(7) ! Array to hold corresponding
! dimension sizes of data buffer buf;
! dim(k) has value of the k-th dimension
! of buffer buf;
! values are ignored if buf is a scalar
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id
! Memory dataspace identfier
! Default value is H5S_ALL_F
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id
! File dataspace identfier
! Default value is H5S_ALL_F
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp
! Transfer property list identifier
! Default value is H5P_DEFAULT_F
END SUBROUTINE h5dwrite_f
</pre>
<p>&nbsp;
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5dwrite_f</strong>
(for object reference and dataset region reference datatypes)
<pre>
SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, n, hdferr, &
mem_space_id, file_space_id, xfer_prp)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier
TYPE, INTENT(IN) :: buf(*) ! Data buffer of rank 1
TYPE, INTENT(IN) :: n ! Buffer size, 1 dimension only
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id
@ -254,10 +329,9 @@ FORTRAN Dataset API -- h5d
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
Last modified: 20 October 1999
Last modified: 29 June 2001
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch
</body>
</html>

71
doc/html/fortran/h5p_FORTRAN.html
View File

@ -508,6 +508,8 @@ FORTRAN Property List API -- h5p
</pre>
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -529,6 +531,9 @@ FORTRAN Property List API -- h5p
</pre>
-->
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -553,6 +558,9 @@ FORTRAN Property List API -- h5p
</pre>
-->
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -574,6 +582,9 @@ FORTRAN Property List API -- h5p
</pre>
-->
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -598,6 +609,8 @@ FORTRAN Property List API -- h5p
</pre>
-->
<p>&nbsp;
<p>&nbsp;
<hr>
@ -644,6 +657,8 @@ FORTRAN Property List API -- h5p
</pre>
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -666,6 +681,9 @@ FORTRAN Property List API -- h5p
</pre>
-->
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -687,6 +705,9 @@ FORTRAN Property List API -- h5p
</pre>
-->
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -713,6 +734,9 @@ FORTRAN Property List API -- h5p
</pre>
-->
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -739,6 +763,8 @@ FORTRAN Property List API -- h5p
</pre>
-->
<p>&nbsp;
<p>&nbsp;
<hr>
@ -1202,15 +1228,15 @@ FORTRAN Property List API -- h5p
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5pset_mpi_f">
<a name="h5pset_fapl_mpi_f">
<p>&nbsp;
</a>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pset_mpi_f</strong>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pset_fapl_mpi_f</strong>
<pre>
SUBROUTINE h5pset_mpi_f(prp_id, comm, info, hdferr)
SUBROUTINE h5pset_fapl_mpi_f(prp_id, comm, info, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
INTEGER, INTENT(IN) :: comm ! MPI communicator to be used for file open
@ -1218,7 +1244,7 @@ FORTRAN Property List API -- h5p
INTEGER, INTENT(IN) :: info ! MPI info object to be used for file open
! as defined in MPI_FILE_OPEN of MPI-2
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5pset_mpi_f
END SUBROUTINE h5pset_fapl_mpi_f
</pre>
@ -1226,22 +1252,22 @@ FORTRAN Property List API -- h5p
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5pget_mpi_f">
<a name="h5pget_fapl_mpi_f">
<p>&nbsp;
</a>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pget_mpi_f</strong>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pget_fapl_mpi_f</strong>
<pre>
SUBROUTINE h5pget_mpi_f(prp_id, comm, info, hdferr)
SUBROUTINE h5pget_fapl_mpi_f(prp_id, comm, info, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
INTEGER, INTENT(OUT) :: comm ! buffer to return communicator
INTEGER, INTENT(IN) :: info ! buffer to return info object
! as defined in MPI_FILE_OPEN of MPI-2
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5pget_mpi_f
END SUBROUTINE h5pget_fapl_mpi_f
</pre>
@ -1249,23 +1275,22 @@ FORTRAN Property List API -- h5p
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5pset_xfer_f">
<a name="h5pset_dxpl_mpi_f">
<p>&nbsp;
</a>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pset_xfer_f</strong>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pset_dxpl_mpi_f</strong>
<pre>
SUBROUTINE h5pset_xfer_f(prp_id, data_xfer_mode, hdferr)
SUBROUTINE h5pset_dxpl_mpi_f(prp_id, data_xfer_mode, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
INTEGER, INTENT(IN) :: data_xfer_mode ! Data transfer mode. Possible values are:
! H5D_XFER_INDEPENDENT_F (0)
! H5D_XFER_COLLECTIVE_F (1)
! H5D_XFER_DFLT_F (2)
! H5FD_MPIO_INDEPENDENT_F (0)
! H5FD_MPIO_COLLECTIVE_F (1)
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5pset_xfer_f
END SUBROUTINE h5pset_dxpl_mpi_f
</pre>
@ -1273,23 +1298,22 @@ FORTRAN Property List API -- h5p
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5pget_xfer_f">
<a name="h5pget_dxpl_mpi_f">
<p>&nbsp;
</a>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pget_xfer_f</strong>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5pget_dxpl_mpi_f</strong>
<pre>
SUBROUTINE h5pget_xfer_f(prp_id, data_xfer_mode, hdferr)
SUBROUTINE h5pget_dxpl_mpi_f(prp_id, data_xfer_mode, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
INTEGER, INTENT(OUT) :: data_xfer_mode ! Data transfer mode. Possible values are:
! H5D_XFER_INDEPENDENT_F (0)
! H5D_XFER_COLLECTIVE_F (1)
! H5D_XFER_DFLT_F (2)
! H5FD_MPIO_INDEPENDENT_F (0)
! H5FD_MPIO_COLLECTIVE_F (1)
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5pget_xfer_f
END SUBROUTINE h5pget_dxpl_mpi_f
</pre>
@ -1307,10 +1331,9 @@ FORTRAN Property List API -- h5p
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
Last modified: 17 July 2000
Last modified: 19 February 2001
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch
</body>
</html>

19
doc/html/fortran/h5r_FORTRAN.html
View File

@ -98,22 +98,22 @@ FORTRAN Reference API -- h5r
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5rget_region_region_f">
<a name="h5rget_region_f">
<p>&nbsp;
</a>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5rget_region_region_f</strong>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5rget_region_f</strong>
<pre>
SUBROUTINE h5rget_region_region_f(dset_id, ref, space_id, hdferr)
SUBROUTINE h5rget_region_f(dset_id, ref, space_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Dataset region reference
INTEGER(HID_T), INTENT(OUT) :: space_id ! Space identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5rget_region_region_f
END SUBROUTINE h5rget_region_f
</pre>
@ -121,15 +121,15 @@ FORTRAN Reference API -- h5r
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5rget_object_type_obj_f">
<a name="h5rget_object_type_f">
<p>&nbsp;
</a>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5rget_object_type_obj_f</strong>
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5rget_object_type_f</strong>
<pre>
SUBROUTINE h5rget_object_type_obj_f(dset_id, ref, obj_type, hdferr)
SUBROUTINE h5rget_object_type_f(dset_id, ref, obj_type, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
TYPE(hobj_ref_t_f), INTENT(IN) :: ref ! Object reference
@ -142,7 +142,7 @@ FORTRAN Reference API -- h5r
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5rget_object_type_obj_f
END SUBROUTINE h5rget_object_type_f
</pre>
@ -158,10 +158,9 @@ FORTRAN Reference API -- h5r
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
Last modified: 13 July 2000
Last modified: 3 April 2000
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch
</body>
</html>

11
doc/html/fortran/h5t_FORTRAN.html
View File

@ -877,6 +877,8 @@ FORTRAN Datatype API -- h5t
</pre>
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -906,6 +908,8 @@ FORTRAN Datatype API -- h5t
</pre>
-->
<p>&nbsp;
<p>&nbsp;
<hr>
@ -1002,6 +1006,8 @@ FORTRAN Datatype API -- h5t
</pre>
<!-- [removed -- underlying C function removed from library]
<p>&nbsp;
<p>&nbsp;
<hr>
@ -1032,6 +1038,8 @@ FORTRAN Datatype API -- h5t
END SUBROUTINE h5tinsert_array_f
</pre>
-->
<p>&nbsp;
<p>&nbsp;
@ -1217,10 +1225,9 @@ FORTRAN Datatype API -- h5t
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
Last modified: 14 July 2000
Last modified: 19 February 2001
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch
</body>
</html>