[svn-r3458]

Purpose:
    Updating FORTRAN API
Description:
    RM_H5P.html
    fortran/h5p_FORTRAN.html
        Made H5Pset_fapl_split warning into a separate paragraph so that
            it is more visible.                 [RM_H5P.html only]
        Removed
            h5pset_stdio_f            h5pset_sec2_f
            h5pget_stdio_f            h5pget_sec2_f
            h5pset_core_f             h5pset_family_f
            h5pget_core_f             h5pget_family_f
        Replaced
            h5pset_mpi_f              h5pset_xfer_f
            h5pget_mpi_f              h5pget_xfer_f
           with
            h5pset_fapl_mpio_f        h5pset_dxpl_mpio_f
            h5pget_fapl_mpio_f        h5pget_dxpl_mpio_f

Platforms tested:
    IE 5
This commit is contained in:
Frank Baker
2001-02-19 16:42:59 -05:00
parent cdc3e26bad
commit 61a9b421fd
2 changed files with 96 additions and 77 deletions

View File

@@ -232,43 +232,6 @@ facilitate moving easily between them.</i>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<i>File Access Properties</i>
<ul>
<li><a href="#Property-GetDriver">h5pget_driver_f</a>
<li><a href="#Property-SetStdio">h5pset_stdio_f</a>
<li><a href="#Property-GetStdio">h5pget_stdio_f</a>
<li><a href="#Property-SetSec2">h5pset_sec2_f</a>
<li><a href="#Property-GetSec2">h5pget_sec2_f</a>
<li><a href="#Property-SetAlignment">h5pset_alignment_f</a>
<li><a href="#Property-GetAlignment">h5pget_alignment_f</a>
<li><a href="#Property-SetCore">h5pset_core_f</a>
<li><a href="#Property-GetCore">h5pget_core_f</a>
<li><a href="#Property-SetMPI">h5pset_mpi_f</a>&nbsp;&nbsp;&nbsp;||
<li><a href="#Property-GetMPI">h5pget_mpi_f</a>&nbsp;&nbsp;&nbsp;||
<!--<li><a href="#Property-SetFamily">h5pset_family_f</a> -->
<!--<li><a href="#Property-GetFamily">h5pget_family_f</a> -->
<li><a href="#Property-SetCache">h5pset_cache_f</a>
<li><a href="#Property-GetCache">h5pget_cache_f</a>
<li><a href="#Property-SetSplit">h5pset_split_f</a>
<li><a href="#Property-GetSplit">h5pget_split_f</a>
<li><a href="#Property-SetGCReferences">h5pset_gc_references_f</a>
<li><a href="#Property-GetGCReferences">h5pget_gc_references_f</a>
</ul>
<!--
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
-->
<br>&nbsp;
<br>
||&nbsp;&nbsp;<i>Available only in the parallel HDF5 library.</i>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<i>Dataset Creation Properties</i>
<ul>
<li><a href="#Property-SetLayout">h5pset_layout_f</a>
@@ -289,6 +252,45 @@ facilitate moving easily between them.</i>
<li><a href="#Property-GetExternal">h5pget_external_f</a>
</ul>
<!--
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
-->
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
<br>
||&nbsp;&nbsp;<i>Available only in the parallel HDF5 library.</i>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<i>File Access Properties</i>
<ul>
<li><a href="#Property-GetDriver">h5pget_driver_f</a>
<!--<li><a href="#Property-SetStdio">h5pset_stdio_f</a> -->
<!--<li><a href="#Property-GetStdio">h5pget_stdio_f</a> -->
<!--<li><a href="#Property-SetSec2">h5pset_sec2_f</a> -->
<!--<li><a href="#Property-GetSec2">h5pget_sec2_f</a> -->
<li><a href="#Property-SetAlignment">h5pset_alignment_f</a>
<li><a href="#Property-GetAlignment">h5pget_alignment_f</a>
<!--<li><a href="#Property-SetCore">h5pset_core_f</a> -->
<!--<li><a href="#Property-GetCore">h5pget_core_f</a> -->
<li><a href="#Property-SetFaplMpio">h5pset_fapl_mpi_f</a>&nbsp;&nbsp;&nbsp;||
<li><a href="#Property-GetFaplMpio">h5pget_fapl_mpi_f</a>&nbsp;&nbsp;&nbsp;||
<!--<li><a href="#Property-SetFamily">h5pset_family_f</a> -->
<!--<li><a href="#Property-GetFamily">h5pget_family_f</a> -->
<li><a href="#Property-SetCache">h5pset_cache_f</a>
<li><a href="#Property-GetCache">h5pget_cache_f</a>
<li><a href="#Property-SetSplit">h5pset_split_f</a>
<li><a href="#Property-GetSplit">h5pget_split_f</a>
<li><a href="#Property-SetGCReferences">h5pset_gc_references_f</a>
<li><a href="#Property-GetGCReferences">h5pget_gc_references_f</a>
</ul>
<p><i>Dataset Memory and Transfer Properties</i>
<ul>
<!--<li><a href="#Property-SetBuffer">h5pset_buffer_f</a> -->
@@ -299,8 +301,8 @@ facilitate moving easily between them.</i>
<li><a href="#Property-GetHyperCache">h5pget_hyper_cache_f</a>
<li><a href="#Property-SetBTreeRatios">h5pset_btree_ratios_f</a>
<li><a href="#Property-GetBTreeRatios">h5pget_btree_ratios_f</a>
<li><a href="#Property-SetXfer">h5pset_xfer_f</a>&nbsp;&nbsp;&nbsp;||
<li><a href="#Property-GetXfer">h5pget_xfer_f</a>&nbsp;&nbsp;&nbsp;||
<li><a href="#Property-SetDxplMpio">h5pset_dxpl_mpi_f</a>&nbsp;&nbsp;&nbsp;||
<li><a href="#Property-GetDxplMpio">h5pget_dxpl_mpi_f</a>&nbsp;&nbsp;&nbsp;||
</ul>
</td></tr>
@@ -2751,11 +2753,9 @@ facilitate moving easily between them.</i>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_fapl_mpi_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
@@ -2795,11 +2795,9 @@ facilitate moving easily between them.</i>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_fapl_mpi_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
@@ -2842,11 +2840,9 @@ facilitate moving easily between them.</i>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_dxpl_mpi_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
@@ -2882,11 +2878,9 @@ facilitate moving easily between them.</i>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_dxpl_mpi_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
@@ -3184,8 +3178,9 @@ facilitate moving easily between them.</i>
HDF5 Releases 1.0 and 1.2.
The split file driver stored metadata and raw data in separate files
but provide no mechanism for separating types of metadata.
(Caution: this function maybe changed in the next release due to a
pending extension to the function.)
<p>
<b><i>Caution:</i></b> This function may be changed in the next release due to a
pending extension to the function.
<p>
<code>fapl_id</code> is a file access property list identifier.
<p>

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,9 +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.2.2, July 2000
Describes HDF5 Release 1.4, February 2001
</body>
</html>