From 030c5e8e4e95d848edb3362d162cee8ae4183e19 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 6 May 2003 17:27:51 -0500 Subject: [svn-r6817] Purpose: New features. Description: Added 3 new functions: H5Gget_num_objs H5Gget_objname_by_idx H5Gget_objtype_by_idx Platforms tested: Safari, IE 5 --- doc/html/RM_H5G.html | 219 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 202 insertions(+), 17 deletions(-) diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 65b86dd..1c8bbe6 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -59,22 +59,26 @@ of objects in an HDF5 file.
  • H5Gcreate
  • H5Gopen
  • H5Gclose -
  • H5Giterate +
  • H5Gset_comment +
  • H5Gget_comment        - + +        @@ -100,8 +104,8 @@ facilitate moving easily between them.
  • h5gcreate_f
  • h5gopen_f
  • h5gclose_f -
  • h5gget_obj_info_idx_f -
  • h5gn_members_f +
  • h5gset_comment_f +
  • h5gget_comment_f               @@ -754,6 +760,185 @@ create or access function. + + + + + + + + +
    +
    +
    Name: H5Gget_num_objs +
    Signature: +
    herr_t H5Gget_num_objs(hid_t loc_id, + hsize_t* num_obj) +
    Purpose: +
    Returns number of objects in the group specified by its identifier +
    Description: +
    H5Gget_num_objs returns number of objects in a group. + Group is specified by its identifier loc_id. + If file identifier is passed in, then number of objects in the + root group is returned. +
    Parameters: +
    +
    hid_t loc_id +
    IN: Identifier of the group or the file +
    hsize_t* num_obj +
    OUT: Number of objects in the group. +
    +
    Returns: +
    Returns positive value if successful; + otherwise returns a negative value. +
    + + + + +
    +
    +
    Name: H5Gget_objname_by_idx +
    Signature: +
    ssize_t H5Gget_objname_by_idx(hid_t group_id, + hsize_t idx, + char *name, + size_t* size ) +
    Purpose: +
    Returns a name of an object specified by an index. +
    Description: +
    H5Gget_objname_by_idx returns a name of the object + specified by the index idx in the group group_id. +

    + The group is specified by a group identifier group_id. + If preferred, a file identifier may be passed in group_id; + that file's root group will be assumed. +

    + idx is the transient index used to iterate through + the objects in the group. + The value of idx is any nonnegative number less than + the total number of objects in the group, which is returned by the + functioin H5Gget_num_objects. + Note that this is a transient index; an object may have a + different index each time a group is opened. +

    + The object name is returned in the user-specified buffer name. +

    + If the size of the provided buffer name is + less or equal the actual object name length, + the object name is truncated to max_size - 1 characters. +

    + Note that if the size of the object's name is unkown, a + preliminary call to H5Gget_objname_by_idx will return + that value. A second call to H5Gget_objname_by_idx + can then be used to retrieve the actual name. +

    Parameters: +
    +
    hid_t group_id +
    IN: Group or file identifier. +
    hsize_t idx +
    IN: Transient index identifying object. +
    char *name +
    IN/OUT: Pointer to user-provided buffer the object name. +
    size_t size +
    IN: Name length. +
    +
    Returns: +
    Returns the size of the object name if successful, + or 0 if no name is associated with the group identifier. + Otherwise returns a negative value. +
    + + +
    +
    +
    Name: H5Gget_objtype_by_idx +
    Signature: +
    int H5Gget_objtype_by_idx(hid_t group_id, + hsize_t idx ) +
    Purpose: +
    Returns the type of an object specified by an index. +
    Description: +
    H5Gget_objtype_by_idx returns the type of the object + specified by the index idx in the group group_id. +

    + The group is specified by a group identifier group_id. + If preferred, a file identifier may be passed in group_id; + that file's root group will be assumed. +

    + idx is the transient index used to iterate through + the objects in the group. + This parameter is described in more detail in the discussion of + H5Gget_objname_by_idx. +

    + The object type is returned as the function return value: + + + + + +
    +      + + H5G_LINK + + + 0 + + Object is a symbolic link. +
      + + + H5G_GROUP + + + 1 + + Object is a group. +
      + + + H5G_DATASET    + + + 2    + + Object is a dataset. +
      + + + H5G_TYPE + + + 3 + + Object is a named datatype. +
    + +

    Parameters: +
    +
    hid_t group_id +
    IN: Group or file identifier. +
    hsize_t idx +
    IN: Transient index identifying object. +
    +
    Returns: +
    Returns the type of the object if successful. + Otherwise returns a negative value. +
    + + + + + + + + +
    Name: H5Gget_linkval @@ -948,7 +1133,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 12 August 2002 +Last modified: 22 April 2003 -- cgit v0.12