Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5O_GET_COMMENT_BY_NAME

Retrieves comment for specified object

Procedure:

H5O_GET_COMMENT_BY_NAME(loc_id, name, comment, bufsize, lapl_id)

Signature:

ssize_t H5Oget_comment_by_name( hid_t loc_id, const char *name, char *comment, size_t bufsize, hid_t lapl_id )

  SUBROUTINE h5oget_comment_by_name_f(loc_id, name,    &
        comment, hdferr, bufsize, lapl_id)
    IMPLICIT NONE
    INTEGER(HID_T)  , INTENT(IN)            :: loc_id
    CHARACTER(LEN=*), INTENT(IN)            :: name
    CHARACTER(LEN=*), INTENT(OUT)           :: comment
    INTEGER         , INTENT(OUT)           :: hdferr
    INTEGER(SIZE_T) , INTENT(OUT), OPTIONAL :: bufsize 
    INTEGER(HID_T)  , INTENT(IN) , OPTIONAL :: lapl_id 

Parameters:
hid_t loc_idIN: Location identifier; may be a file, group, dataset, named datatype or attribute identifier
const char *name    IN: Name of the object whose comment is to be retrieved, specified as a path relative to loc_id 
name can be '.' (a dot) if loc_id fully specifies the object for which the associated comment is to be retrieved
char *commentOUT: The comment
size_t bufsizeIN: Anticipated required size of the comment buffer
hid_t lapl_idIN: Link access property list identifier

Description:

H5O_GET_COMMENT_BY_NAME retrieves the comment for an object in the buffer comment.

The target object is specified by loc_id and name. loc_id can specify any object in the file. name can be one of the following: 
  — The name of the object relative to loc_id 
  — An absolute name of the object, starting from /, the file’s root group 
  — A dot (.), if loc_id fully specifies the object

The size in bytes of the comment, including the NULL terminator, is specified in bufsize. If bufsize is unknown, a preliminary H5O_GET_COMMENT_BY_NAME call with the pointer comment set to NULL will return the size of the comment without the NULL terminator.

If bufsize is set to a smaller value than described above, only bufsize bytes of the comment, without a NULL terminator, are returned in comment.

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

lapl_id contains a link access property list identifier. A link access propety list can come into play when traversing links to access an object.

Returns:

Upon success, returns the number of characters in the comment, not including the NULL terminator, or zero (0) if the object has no comment. The value returned may be larger than bufsize. Otherwise returns a negative value.

Example:

Coming Soon!

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

--- Last Modified: May 07, 2018 | 12:44 PM