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

Procedure:

H5P_GET_LOCAL_HEAP_SIZE_HINT ( gcpl_id, size_hint )

Signature:

<pre><code class="language-c">herr_t H5Pget_local_heap_size_hint(
        hid_t gcpl_id,
        size_t *size_hint
    )
  </code></pre>

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

Description:
H5P_GET_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 H5P_SET_LOCAL_HEAP_SIZE_HINT for further discussion.

Returns:

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

Example:

Coming Soon!

History:
Release    Change
1.8.0Function introduced in this release.