summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5A.html
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-12-17 15:33:08 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-12-17 15:33:08 (GMT)
commitf17e2d273e083a5ac35975d90c9c74c1480e7d3c (patch)
tree4b8bfd3b02f601acfaffae2f5e41979748d616a1 /doc/html/RM_H5A.html
parent9de79f7952a157fa176ec356409ec57279e879ae (diff)
downloadhdf5-f17e2d273e083a5ac35975d90c9c74c1480e7d3c.zip
hdf5-f17e2d273e083a5ac35975d90c9c74c1480e7d3c.tar.gz
hdf5-f17e2d273e083a5ac35975d90c9c74c1480e7d3c.tar.bz2
[svn-r1885] RM_H5.html H5check_version: Grammar correction.
RM_H5A.html H5Acreate: Restructured and expanded the Description section, with particular attention to the fact that the attribute name specified in H5Acreate must be unique.
Diffstat (limited to 'doc/html/RM_H5A.html')
-rw-r--r--doc/html/RM_H5A.html32
1 files changed, 19 insertions, 13 deletions
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>