mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-02-17 16:10:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

[svn-r1885] RM_H5.html H5check_version: Grammar correction.

Browse Source 
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.
This commit is contained in:
Frank Baker 1999-12-17 10:33:08 -05:00
parent 9de79f7952
commit f17e2d273e
2 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/html/RM_H5.html
View File

@ -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

32
doc/html/RM_H5A.html
View File

@ -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>