Logo Search packages:      
Sourcecode: jhdf version File versions  Download package

static synchronized native int ncsa::hdf::hdf5lib::H5::H5Gget_comment ( int  loc_id,
String  name,
int  bufsize,
String[]  comment 
) throws ArrayIndexOutOfBoundsException, ArrayStoreException, HDF5LibraryException, NullPointerException, IllegalArgumentException [static]

H5Gget_comment retrieves the comment for the the object name. The comment is returned in the buffer comment.

Parameters:
loc_id IN: Identifier of the file, group, dataset, or datatype.
name IN: Name of the object whose comment is to be set or reset.
bufsize IN: Anticipated size of the buffer required to hold comment.
comment OUT: The comment.
Returns:
the number of characters in the comment, counting the null terminator, if successful
Exceptions:
ArrayIndexOutOfBoundsException - JNI error writing back data
ArrayStoreException - JNI error writing back data
HDF5LibraryException - Error from the HDF-5 Library.
NullPointerException - name is null.
IllegalArgumentException - size < 1, comment is invalid.


Generated by  Doxygen 1.6.0   Back to index