Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

H5O.get_comment_by_name

Get comment for object specified by location and object name

Syntax

comment = H5O.get_comment_by_name(loc_id,name,lapl_id)

Description

comment = H5O.get_comment_by_name(loc_id,name,lapl_id) retrieves a comment where a location id and name together specify the object. A link access property list can affect the outcome if a link is traversed to access the object.

Examples

fid = H5F.open('example.h5','H5F_ACC_RDONLY','H5P_DEFAULT');
comment = H5O.get_comment_by_name(fid,'g4/world','H5P_DEFAULT');
H5F.close(fid);
Was this topic helpful?