Returns number of objects in the group specified by its identifier

This function is deprecated in favor of the function H5G_GET_INFO.

 

Procedure:

H5G_GET_NUM_OBJS(loc_id, num_obj)

Signature:

<pre><code class="language-c">herr_t H5Gget_num_objs(hid_t loc_id, hsize_t* num_obj)</code></pre>

Parameters:
hid_t loc_idIN: Identifier of the group or the file
hsize_t *num_obj    OUT: Number of objects in the group

Description:

H5G_GET_NUM_OBJS returns number of objects in a group. Group is specified by its identifier loc_id. If a file identifier is passed in, then the number of objects in the root group is returned.

Returns:

Returns positive value if successful; otherwise returns a negative value.

Example:

Coming soon!

 

History:
Release    Change
1.6.0Function introduced in this release.
1.8.0Function deprecated in this release.