From 349b9094a0755986cb9df6e6f662791c98afaa15 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 12 Aug 1998 09:16:39 -0500 Subject: [svn-r587] Added H5Gset_comment and H5Gget_comment. --- doc/src/RM_H5G.html | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 91 insertions(+), 3 deletions(-) diff --git a/doc/src/RM_H5G.html b/doc/src/RM_H5G.html index 55b7d5b..178737b 100644 --- a/doc/src/RM_H5G.html +++ b/doc/src/RM_H5G.html @@ -38,20 +38,22 @@ of objects on disk.
  • H5Gopen
  • H5Gset
  • H5Gclose +
  • H5Gpush               (NYI = Not yet implemented) @@ -612,6 +614,92 @@ then be trivial. + + + + +
    +
    +
    Name: H5Gset_comment +
    Signature: +
    herr_t H5Gset_comment(hid_t loc_id, + const char *name, + const char *comment + ) +
    Purpose: +
    Sets comment for specified object. +
    Description: +
    H5Gset_comment sets the comment for the the + object name to comment. + Any previously existing comment is overwritten. +

    + If comment is the empty string or a + null pointer, the comment message is removed from the object. +

    + Comments should be relatively short, null-terminated, + ASCII strings. +

    Parameters: +
    +
    hid_t loc_id +
    IN: Identifier of the file or group . +
    const char *name +
    IN: Name of the object whose comment is to be set or reset. +
    const char *comment +
    IN: The new comment. +
    +
    Returns: +
    Returns SUCCEED (0) if successful; + otherwise returns FAIL (-1). +
    + + +
    +
    +
    Name: H5Gget_comment +
    Signature: +
    herr_t H5Gget_comment(hid_t loc_id, + const char *name, + size_t bufsize, + char *comment + ) +
    Purpose: +
    Retrieves comment for specified object. +
    Description: +
    H5Gget_comment retrieves the comment for the the + object name. The comment is returned in the buffer + comment. +

    + At most bufsize characters, including a null + terminator, are copied. The result is not null terminated + if the comment is longer than the supplied buffer. +

    + If an object does not have a comment, the empty string + is returned. +

    Parameters: +
    +
    hid_t loc_id +
    IN: Identifier of the file or group . +
    const char *name +
    IN: Name of the object whose comment is to be set or reset. +
    size_t bufsize +
    IN: Anticipated size of the buffer required to hold + comment. +
    char *comment +
    OUT: The comment. +
    +
    Returns: +
    Returns the number of characters in the comment, + counting the null terminator, if successful; the value + returned may be larger than bufsize. + Otherwise returns FAIL (-1). +
    + + + + + + +
    HDF5 Reference Manual  -- cgit v0.12