Last modified: 10 April 2013
Name: H5Oset_comment
Signature:
  herr_t `H5Oset_comment`( hid_t `object_id`, const char *`comment` )

Purpose:
  Sets comment for specified object.

Deprecated Function:
  This function is deprecated in favor of object attributes.

Description:
  `H5Oset_comment` sets the comment for the specified object to the contents of `comment`. Any previously existing comment is overwritten.

  The target object is specified by an identifier, `object_id`.

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

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

  Comments can be attached to any object that has an object header. Datasets, groups, and committed (named) datatypes have object headers. Symbolic links do not have object headers.

  If a comment is being added to an object attribute, this comment will be attached to the object to which the attribute belongs and not to the attribute itself.

Parameters:

  hid_t `object_id` | IN: Identifier of the target object
  const char *`comment` | IN: The new comment.

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

Fortran90 Interface: h5oset_comment_f

History:

  Release | C
  1.8.11 | Fortran subroutine introduced in this release.
  1.8.0 | Function introduced in this release.