From 72f1dea7fbfed8f4bf7583d65287e1eeeee56188 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 21 Oct 2003 16:13:32 -0500 Subject: [svn-r7689] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Add H5Fget_freelist/h5fget_freelist_f Platforms tested: Safari, IE 5 --- doc/html/RM_H5F.html | 364 ++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 304 insertions(+), 60 deletions(-) diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index c14c064..2dad429 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -81,21 +81,22 @@ documented below.
  • H5Fopen
  • H5Freopen
  • H5Fclose +
  • H5Fflush               @@ -119,11 +120,11 @@ documented below. @@ -131,6 +132,7 @@ documented below.               @@ -237,10 +240,20 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -345,10 +358,39 @@ facilitate moving easily between them.
    Returns:
    Returns a file identifier if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -402,10 +444,23 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -439,10 +494,22 @@ facilitate moving easily between them.
    Returns:
    Returns a file access property list identifier if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -479,10 +546,74 @@ facilitate moving easily between them.
    Returns:
    Returns a file creation property list identifier if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - + + + + + +
    +
    +
    Name: H5Fget_freespace +
    Signature: +
    hssize_t H5Fget_freespace(hid_t file_id) +
    Purpose: +
    Returns the amount of free space in a file. +
    Description: +
    Given the identifier of an open file, file_id, + H5Fget_freespace returns the amount of space that is + unused by any objects in the file. +

    + Currently, the HDF5 library only tracks free space in a file from a + file open or create until that file is closed, so this routine will + only report the free space that has been created during that + interval. +

    Parameters: +
    +
    hid_t file_id +
    IN: Identifier of a currently-open HDF5 file +
    +
    Returns: +
    Returns a the amount of free space in the file if successful; + otherwise returns a negative value. +
    Returns: +
    Returns a file creation property list identifier if successful; + otherwise returns a negative value. +
    Fortran90 Interface: h5fget_freespace_f +
    + 
    +SUBROUTINE h5fget_freespace_f(file_id, free_space, hdferr)
+
+  IMPLICIT NONE 
+  INTEGER(HID_T), INTENT(IN)  :: file_id       ! File identifier
+  INTEGER(HSSIZE_T), INTENT(OUT) :: free_space ! Amount of free space in file
+  INTEGER, INTENT(OUT)        :: hdferr        ! Error code 
+                                               ! 0 on success and -1 on failure
+END SUBROUTINE h5fget_freespace_f 
+
    + + @@ -559,10 +690,28 @@ facilitate moving easily between them.
    Returns:
    Returns a the number of open objects if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -612,10 +761,32 @@ facilitate moving easily between them.
    Returns:
    Returns number of objects placed into obj_id_list if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -665,11 +836,18 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. +
    Fortran90 Interface: +
    None. + + + @@ -697,10 +875,23 @@ facilitate moving easily between them.
    When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. Otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -744,10 +935,22 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -844,10 +1047,29 @@ facilitate moving easily between them.
    Returns:
    Returns a file identifier if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -889,10 +1111,21 @@ facilitate moving easily between them.
    Returns:
    Returns a new file identifier if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -935,10 +1168,21 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -986,7 +1230,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 -- cgit v0.12