Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5F_MOUNT

Mounts a file

Procedure:

H5F_MOUNT (loc_id, name, child_id, fmpl_id)

Signature:

herr_t H5Fmount(hid_t loc_id, const char *name, hid_t child_id, hid_t fmpl_id )

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 location loc_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

Parameters:
hid_t loc_idIN: Identifier for object in which name is defined; may be a file, group, dataset, named datatype or attribute
const char *name    IN: Name of the group onto which the file specified by child_id is to be mounted
hid_t child_idIN: Identifier of the file to be mounted
hid_t fmpl_idIN: File mount property list identifier
Pass H5P_DEFAULT (see note above).

Description:

H5F_MOUNT mounts the file specified by child_id onto the object specified by loc_id and name using the mount properties fmpl_id. If the object specified by loc_id is a dataset, named datatype or attribute, then the file will be mounted at the location where the attribute, dataset, or named datatype is attached.

Note:
To date, no file mount properties have been defined in HDF5. The proper value to pass for fmpl_id is H5P_DEFAULT, indicating the default file mount property list.

Returns:

Returns a non-negative value if successful; otherwise returns a negative value. 

Example:

Coming soon!

--- Last Modified: December 20, 2018 | 11:36 AM