diff options
author | Frank Baker <fbaker@hdfgroup.org> | 2002-01-16 18:14:44 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 2002-01-16 18:14:44 (GMT) |
commit | 9ed500a8aa9eeab2c1d6b3279dc36b6cf99387bb (patch) | |
tree | 256e293d2303018a49a932322b796b1efa918fe8 /doc | |
parent | 32c12d34d18e694f0fd9e592aaf2c48b8f21723b (diff) | |
download | hdf5-9ed500a8aa9eeab2c1d6b3279dc36b6cf99387bb.zip hdf5-9ed500a8aa9eeab2c1d6b3279dc36b6cf99387bb.tar.gz hdf5-9ed500a8aa9eeab2c1d6b3279dc36b6cf99387bb.tar.bz2 |
[svn-r4832]
Purpose:
Bugfix and clarification.
Description:
H5Aclose -- Changed statement regarding future use of a released
attribute identifier.
H5Acreate -- Corrected create_plist_id reference and listed H5P_DEFAULT
as only currently-accepted value.
Platforms tested:
IE 5
Diffstat (limited to 'doc')
-rw-r--r-- | doc/html/RM_H5A.html | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index e36f24f..86e8813 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -169,8 +169,10 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <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. + The attribute creation property list, <code>create_plist</code>, + is currently unused; + it may be used in the future for optional attribute properties. + At this time, <code>H5P_DEFAULT</code> is the only accepted value. <p> The attribute identifier returned from this function must be released with <code>H5Aclose</code> or resource leaks will develop. @@ -185,7 +187,8 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><em>hid_t</em> <code>space_id</code> <dd>IN: Identifier of dataspace for attribute. <dt><em>hid_t</em> <code>create_plist</code> - <dd>IN: Identifier of creation property list (currently not used). + <dd>IN: Identifier of creation property list. (Currently unused; + the only accepted value is <code>H5P_DEFAULT</code>.) </dl> <dt><strong>Returns:</strong> <dd>Returns an attribute identifier if successful; @@ -624,9 +627,10 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dd>Closes the specified attribute. <dt><strong>Description:</strong> <dd><code>H5Aclose</code> terminates access to the attribute - specified by its identifier, <code>attr_id</code>. - Further use of the attribute identifier will result in - undefined behavior. + specified by <code>attr_id</code> by releasing the identifier. + <p> + Further use of a released attribute identifier is illegal; + a function using such an identifier will fail. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>attr_id</code> @@ -685,7 +689,7 @@ H5A <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 6 July 2000 +Last modified: 18 Dec 2001 <br> Describes HDF5 Release 1.5, Unreleased Development Branch |