From 644f9c0c98e58eab621d41bf8c59394e6ed64355 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 24 Aug 2004 13:57:46 -0500 Subject: [svn-r9143] Purpose: Add H5Fget_name Add H5Fget_filesize Minor correction in HTML coding of H5Fget_freespace Platforms tested: Mozilla --- doc/html/RM_H5F.html | 150 ++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 143 insertions(+), 7 deletions(-) diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index 6d662a3..7156c3b 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -89,11 +89,13 @@ documented below.
  • H5Fmount
  • H5Funmount
  • H5Fget_vfd_handle -
  • H5Fget_create_plist +
  • H5Fget_filesize        @@ -120,11 +123,11 @@ documented below. @@ -132,6 +135,7 @@ documented below.        @@ -577,10 +583,63 @@ END SUBROUTINE h5fget_create_plist_f + +
    +
    +
    Name: H5Fget_filesize +
    Signature: +
    herr_t H5Fget_filesize(hid_t file_id, + hsize_t *size + ) +
    Purpose: +
    Returns the size of an HDF5 file. +
    Description: +
    H5Fget_filesize returns the size + of the HDF5 file specified by file_id. +

    + The returned size is that of the entire file, + as opposed to only the HDF5 portion of the file. + I.e., size includes the user block, if any, + the HDF5 portion of the file, and + any data that may have been appended + beyond the data written through the HDF5 Library. +

    Parameters: +
    +
    hid_t file_id +
    IN: Identifier of a currently-open HDF5 file +
    hsize_t *size +
    OUT: Size of the file, in bytes. +
    +
    Returns: +
    Returns a non-negative value if successful; + otherwise returns a negative value. +
    Fortran90 Interface: h5fget_freespace_f +
    + 
    +SUBROUTINE h5fget_filesize_f(file_id, size, hdferr)
+
+  IMPLICIT NONE
+  INTEGER(HID_T), INTENT(IN) :: file_id    ! file identifier
+  INTEGER(HSIZE_T), INTENT(OUT) :: size    ! Size of the file 
+  INTEGER, INTENT(OUT) :: hdferr           ! Error code: 0 on success,
+                                           ! -1 if fail
+END SUBROUTINE h5fget_filesize_f 
+
    + + +
    + + +
    -
    Name: H5Fget_freespace +
    Name: H5Fget_freespace
    Signature:
    hssize_t H5Fget_freespace(hid_t file_id)
    Purpose: @@ -627,6 +686,83 @@ END SUBROUTINE h5fget_freespace_f -->
    + + + +
    +
    +
    Name: H5Fget_name +
    Signature: +
    ssize_t H5Fget_name(hid_t obj_id, + char *name, + size_t size + ) + +
    Purpose: +
    Retrieves name of file to which object belongs. +
    Description: +
    H5Fget_name retrieves the name of the file + to which the object obj_id belongs. + The object can be a group, dataset, attribute, or + named datatype. +

    + Up to size characters of the filename + are returned in name; + additional characters, if any, are not returned to + the user application. +

    + If the length of the name, + which determines the required value of size, + is unknown, a preliminary H5Fget_name call + can be made by setting name to NULL. + The return value of this call will be the size of the filename; + that value can then be assigned to size + for a second H5Fget_name call, + which will retrieve the actual name. +

    + If an error occurs, the buffer pointed to by + name is unchanged and + the function returns a negative value. +

    Parameters: +
    +
    hid_t obj_id +
    IN: Identifier of the object for which the + associated filename is sought. + The object can be a group, dataset, attribute, or + named datatype. +
    char *name +
    OUT: Buffer to contain the returned filename. +
    size_t size +
    IN: Size, in bytes, of the name buffer. +
    +
    Returns: +
    Returns the length of the filename if successful; + otherwise returns a negative value. +
    Fortran90 Interface: h5fget_name_f +
    + 
    +SUBROUTINE h5fget_name_f(obj_id, buf, size, hdferr)
+
+  IMPLICIT NONE
+  INTEGER(HID_T), INTENT(IN) :: obj_id     ! Object identifier 
+  CHARACTER(LEN=*), INTENT(INOUT) :: buf   ! Buffer to hold filename
+  INTEGER(SIZE_T), INTENT(OUT) :: size     ! Size of the filename
+  INTEGER, INTENT(OUT) :: hdferr           ! Error code: 0 on success,
+                                           ! -1 if fail
+  INTEGER(SIZE_T) :: buflen
+
+END SUBROUTINE h5fget_name_f
+
    + + +
    + +
    @@ -1260,7 +1396,7 @@ And in this document, the Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 -- cgit v0.12