Name: H5Pget_local_heap_size_hint
Signature:
herr_t H5Pget_local_heap_size_hint( hid_t gcpl_id, size_t *size_hint )

Purpose:
Retrieves the anticipated size of the local heap for original-style groups.

Description:
H5Pget_local_heap_size_hint queries the group creation property list, gcpl_id, for the anticipated size of the local heap, size_hint, for original-style groups, i.e., for groups of the style used prior to HDF5 Release 1.8.0.

See H5Pset_local_heap_size_hint for further discussion.

Parameters:
hid_t gcpl_id IN: Group creation property list identifier
size_t *size_hint     OUT: Anticipated size of local heap

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

Fortran90 Interface:
SUBROUTINE h5pget_local_heap_size_hint_f(gcpl_id, size_hint, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: gcpl_id 
                                  ! Group creation property list identifier
  INTEGER(SIZE_T), INTENT(OUT) :: size_hint 
                                  ! Hint for size of local heap
  INTEGER, INTENT(OUT) :: hdferr  ! Error code
                                  ! 0 on success and -1 on failure
END SUBROUTINE h5pget_local_heap_size_hint_f
    

History:
Release     Change
1.8.0 Function introduced in this release.