H5O

[ Top ] [ Modules ]

NAME

  MODULE H5O

FILE

  fortran/src/H5Off.f90

PURPOSE

  This file contains Fortran interfaces for H5O functions. It includes
  all the functions that are independent on whether the Fortran 2003 functions
  are enabled or disabled.

NOTES

                         *** IMPORTANT ***
  If you add a new H5O function you must add the function name to the
  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
  This is needed for Windows based operating systems.

h5oclose_f

[ Top ] [ H5O ] [ Subroutines ]

NAME

  h5oclose_f

PURPOSE

  Closes an object in an HDF5 file.

INPUTS

  object_id     - Object identifier

OUTPUTS

  hdferr        - Returns 0 if successful and -1 if fails

AUTHOR

  M. Scot Breitenfeld
  December 17, 2008

SOURCE

  SUBROUTINE h5oclose_f(object_id, hdferr)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN)  :: object_id
    INTEGER,        INTENT(OUT) :: hdferr

h5olink_f

[ Top ] [ H5O ] [ Subroutines ]

NAME

  h5olink_f

PURPOSE

  Creates a hard link to an object in an HDF5 file.

INPUTS

  object_id     - Object to be linked.
  new_loc_id    - File or group identifier specifying location at which object is to be linked.
  new_link_name - Name of link to be created, relative to new_loc_id.

OUTPUTS

  hdferr:       - error code
                   Success:  0
                   Failure: -1

OPTIONAL PARAMETERS

  lcpl_id       - Link creation property list identifier.
  lapl_id       - Link access property list identifier.

AUTHOR

  M. Scot Breitenfeld
  April 21, 2008

SOURCE

  SUBROUTINE h5olink_f(object_id, new_loc_id, new_link_name, hdferr, lcpl_id, lapl_id)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN) :: object_id  ! Object to be linked
    INTEGER(HID_T), INTENT(IN) :: new_loc_id ! File or group identifier specifying
                                             ! location at which object is to be linked.
    CHARACTER(LEN=*), INTENT(IN) :: new_link_name ! Name of link to be created, relative to new_loc_id.
    INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                          !   Success:  0
                                          !   Failure: -1
    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list identifier.
    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link creation property list identifier.

h5oopen_f

[ Top ] [ H5O ] [ Subroutines ]

NAME

  h5oopen_f

PURPOSE

  Opens an object in an HDF5 file by location identifier and path name.

INPUTS

  loc_id        - File or group identifier
  name          - Path to the object, relative to loc_id.

OUTPUTS

  obj_id        - Object identifier for the opened object
  hdferr:       - error code
                   Success:  0
                   Failure: -1

OPTIONAL PARAMETERS

  lapl_id       - Access property list identifier for the link pointing to the object

AUTHOR

  M. Scot Breitenfeld
  April 18, 2008

SOURCE

  SUBROUTINE h5oopen_f(loc_id, name, obj_id, hdferr, lapl_id)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN) :: loc_id  ! File or group identifier
    CHARACTER(LEN=*), INTENT(IN) :: name  ! Path to the object, relative to loc_id
    INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier for the opened object
    INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                          !   Success:  0
                                          !   Failure: -1
    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id  ! Attribute access property list

h5open_by_addr_f

[ Top ] [ H5O ] [ Subroutines ]

NAME

  h5oopen_by_addr_f

PURPOSE

  Opens an object using its address within an HDF5 file.

INPUTS

    loc_id - File or group identifier
    addr   - Object’s address in the file
 OUTPUTS: 
    obj_id - Object identifier for the opened object
    hdferr - Returns 0 if successful and -1 if fails

AUTHOR

  M. Scot Breitenfeld
  September 14, 2009

SOURCE

  SUBROUTINE h5oopen_by_addr_f(loc_id, addr, obj_id, hdferr)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN) :: loc_id  ! File or group identifier
    INTEGER(HADDR_T), INTENT(IN) :: addr  ! Object’s address in the file
    INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier for the opened object
    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
                                          ! 0 on success and -1 on failure