diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/html/RM_H5.html | 3 | ||||
| -rw-r--r-- | doc/html/RM_H5A.html | 32 |
2 files changed, 21 insertions, 14 deletions
diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 6457994..18d23b5 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -188,7 +188,8 @@ and it users. <dd><code>H5check_version</code> verifies that the arguments match the version numbers compiled into the library. This function is intended to be called by the user to verify that the version of the header files - compiled into the application match the version of the HDF5 library being used. + compiled into the application matches the version of the HDF5 library + being used. <p> Due to the risks of data corruption or segmentation faults, <code>H5check_version</code> causes the application to abort if the diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index e452644..9425dff 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -152,22 +152,28 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dd>Creates a dataset as an attribute of another group, dataset, or named datatype. <dt><strong>Description:</strong> - <dd><code>H5Acreate</code> creates an attribute which is attached - to the object specified with <code>loc_id</code>. - <code>loc_id</code> is an identifier of a group, dataset, - or named datatype. The name specified with <code>name</code> - for each attribute for an object must be unique for that object. + <dd><code>H5Acreate</code> creates an attribute named <code>name</code> + and attached to the object specified with <code>loc_id</code>. + <code>loc_id</code> is a group, dataset, or named datatype identifier. + <p> + The attribute name specified in <code>name</code> must be unique. + Attempting to create an attribute with the same name as an already + existing attribute will fail, leaving the pre-existing attribute + in place. To overwrite an existing attribute with a new attribute + of the same name, first call <code>H5Adelete</code> then recreate + the attribute with <code>H5Acreate</code>. + <p> The datatype and dataspace identifiers of the attribute, <code>type_id</code> and <code>space_id</code>, respectively, are created with the H5T and H5S interfaces, respectively. - Currently only simple dataspaces are allowed for attribute - dataspaces. The <code>create_plist_id</code> property list - is currently unused, but will be used int the future for optional - properties of attributes. The attribute identifier returned from - this function must be released with <code>H5Aclose</code> or - resource leaks will develop. Attempting to create an attribute - with the same name as an already existing attribute will fail, - leaving the pre-existing attribute in place. + <p> + Currently only simple dataspaces are allowed for attribute dataspaces. + <p> + The <code>create_plist_id</code> property list is currently unused; + it will be used in the future for optional attribute properties. + <p> + The attribute identifier returned from this function must be released + with <code>H5Aclose</code> or resource leaks will develop. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> |