summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1998-09-11 15:51:53 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1998-09-11 15:51:53 (GMT)
commitf56f76eb1d5093fca7066f44a428d4b0235996b4 (patch)
treee807c887142207819abddd0ead1b24062d4c8a9b /doc
parentb02e452be5c051ea38de5c5f94300ae97a414aaf (diff)
downloadhdf5-f56f76eb1d5093fca7066f44a428d4b0235996b4.zip
hdf5-f56f76eb1d5093fca7066f44a428d4b0235996b4.tar.gz
hdf5-f56f76eb1d5093fca7066f44a428d4b0235996b4.tar.bz2
[svn-r692] Modified loc_id parameter description to accomodate more more liberal
set of loc_id values. Functions requiring a change: H5Acreate H5Dopen H5Gpop, H5Glink, H5Gget_objinfo, H5Gget_linkval, H5Gset_comment, H5Gget_comment H5Topen
Diffstat (limited to 'doc')
-rw-r--r--doc/src/RM_H5A.html2
-rw-r--r--doc/src/RM_H5D.html3
-rw-r--r--doc/src/RM_H5G.html12
-rw-r--r--doc/src/RM_H5T.html2
4 files changed, 10 insertions, 9 deletions
diff --git a/doc/src/RM_H5A.html b/doc/src/RM_H5A.html
index e0d5308..bda4333 100644
--- a/doc/src/RM_H5A.html
+++ b/doc/src/RM_H5A.html
@@ -110,7 +110,7 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Object (dataset or group) to be attached to.
+ <dd>IN: Object (dataset, group, or named datatype) to be attached to.
<dt><em>const char *</em><code>name</code>
<dd>IN: Name of attribute to create.
<dt><em>hid_t</em> <code>type_id</code>
diff --git a/doc/src/RM_H5D.html b/doc/src/RM_H5D.html
index a5340f7..bb2c4dc 100644
--- a/doc/src/RM_H5D.html
+++ b/doc/src/RM_H5D.html
@@ -123,7 +123,8 @@ and set and retrieve their constant or persistent properties.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>Identifier of the file to access the dataset within.
+ <dd>Identifier of the dataset to open or the file or group
+ to access the dataset within.
<dt><em>const char *</em> <code>name</code>
<dd>The name of the dataset to access.
</dl>
diff --git a/doc/src/RM_H5G.html b/doc/src/RM_H5G.html
index 4e22226..9b0a8a0 100644
--- a/doc/src/RM_H5G.html
+++ b/doc/src/RM_H5G.html
@@ -284,7 +284,7 @@ then be trivial.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>The file or group identifier.
+ <dd>The file, group, dataset, or datatype identifier.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns SUCCEED (0) if successful;
@@ -348,7 +348,7 @@ then be trivial.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>File or group identifier.
+ <dd>File, group, dataset, or datatype identifier.
<dt><em>H5G_link_t</em> <code>link_type</code>
<dd>Link type.
Possible values are <code>H5G_LINK_HARD</code> and <code>H5G_LINK_SOFT</code>.
@@ -566,7 +566,7 @@ then be trivial.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: File, group, or dataset identifier.
+ <dd>IN: File, group, dataset, or datatype identifier.
<dt><em>const char</em> <code>*name</code>
<dd>IN: Name of the object for which status is being sought.
<dt><em>hbool_t</em> <code>follow_link</code>
@@ -608,7 +608,7 @@ then be trivial.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of the file or group .
+ <dd>IN: Identifier of the file, group, dataset, or datatype.
<dt><em>const char *</em><code>name</code>
<dd>IN: Name of the object whose link value is to be checked.
<dt><em>size_t</em> <code>size</code>
@@ -655,7 +655,7 @@ then be trivial.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of the file or group .
+ <dd>IN: Identifier of the file, group, dataset, or datatype.
<dt><em>const char *</em><code>name</code>
<dd>IN: Name of the object whose comment is to be set or reset.
<dt><em>const char *</em><code>comment</code>
@@ -692,7 +692,7 @@ then be trivial.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of the file or group .
+ <dd>IN: Identifier of the file, group, dataset, or datatype.
<dt><em>const char *</em><code>name</code>
<dd>IN: Name of the object whose comment is to be set or reset.
<dt><em>size_t</em> <code>bufsize</code>
diff --git a/doc/src/RM_H5T.html b/doc/src/RM_H5T.html
index 7ed2d7c..086b9cc 100644
--- a/doc/src/RM_H5T.html
+++ b/doc/src/RM_H5T.html
@@ -145,7 +145,7 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>A file or group identifier.
+ <dd>A file, group, or datatype identifier.
<dt><em>const char *</em> <code>name</code>
<dd>A datatype name.
</dl>