summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-12-17 15:37:56 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-12-17 15:37:56 (GMT)
commitd0505ef917c457037844030acc31b38910a6643e (patch)
tree9f2284962f66ac371373474e9063c5dbf73a60e6 /doc
parenta1e336f860757b1d01af5fead390c2fac17524d1 (diff)
downloadhdf5-d0505ef917c457037844030acc31b38910a6643e.zip
hdf5-d0505ef917c457037844030acc31b38910a6643e.tar.gz
hdf5-d0505ef917c457037844030acc31b38910a6643e.tar.bz2
[svn-r1888] RM_H5F.html H5Fcreate, H5Fopen: Clarified description of file access flags
in parameters section and removed reference to H5Fpublic.h. RM_H5D.html H5Dvlen_reclaim: Inserted missing punctuation. H5Dcreate: Added paragraph explaining that 'name' must be unique.
Diffstat (limited to 'doc')
-rw-r--r--doc/html/RM_H5D.html7
-rw-r--r--doc/html/RM_H5F.html27
2 files changed, 19 insertions, 15 deletions
diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html
index 1f8f3df..d4058ad 100644
--- a/doc/html/RM_H5D.html
+++ b/doc/html/RM_H5D.html
@@ -105,6 +105,11 @@ and set and retrieve their constant or persistent properties.
Dataset creation properties are specified by the argument
<code>create_plist_id</code>.
<p>
+ Dataset names within a group are unique:
+ <code>H5Dcreate</code> will return an error if a dataset with
+ the name specified in <code>name</code> already exists at the
+ location specified in <code>loc_id</code>.
+ <p>
<code>create_plist_id</code> is a <code>H5P_DATASET_CREATE</code>
property list created with <code>H5Pcreate()</code> and
initialized with the various functions described above.
@@ -303,7 +308,7 @@ and set and retrieve their constant or persistent properties.
<dl>
<dt><strong>Name:</strong> <a name="Dataset-VLReclaim">H5Dvlen_reclaim</a>
<dt><strong>Signature:</strong>
- <dd><em>herr_t </em><code>H5Dvlen_reclaim</code>(<em>hid_t </em><code>type_id</code>
+ <dd><em>herr_t </em><code>H5Dvlen_reclaim</code>(<em>hid_t </em><code>type_id</code>,
<em>hid_t</em> <code>space_id</code>,
<em>hid_t</em> <code>plist_id</code>,
<em>void</em> *<code>buf</code>
diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html
index c384b6f..9922243 100644
--- a/doc/html/RM_H5F.html
+++ b/doc/html/RM_H5F.html
@@ -115,19 +115,19 @@ documented below.
<dt><em>const char *</em><code>name</code>
<dd>Name of the file to access.
<dt><em>unsigned</em> <code>flags</code>
- <dd>File access flags. Allowable values include:
+ <dd>File access flags. Allowable values are:
<ul><dl>
<dt>H5F_ACC_RDWR
<dd>Allow read and write access to file.
<dt>H5F_ACC_RDONLY
<dd>Allow read-only access to file.
- <dt>H5F_ACC_DEBUG
- <dd>Print debug information.
- (Used only by HDF5 library developers.
- Do not use this flag in applications.)
</dl></ul>
- <code>H5F_ACC_RDWR</code> and <code>H5F_ACC_RDONLY</code>
+ <li><code>H5F_ACC_RDWR</code> and <code>H5F_ACC_RDONLY</code>
are mutually exclusive; use exactly one.
+ <li>An additional flag, <code>H5F_ACC_DEBUG</code>, prints debug
+ information. This flag is used only by HDF5 library
+ developers; it is neither tested nor supported
+ for use in applications.
<dt><em>hid_t</em> <code>access_id</code>
<dd>Identifier for the file access properties list.
If parallel file access is desired, this is a collective
@@ -166,27 +166,26 @@ documented below.
are controlled through the file-creation and file-access
property lists. The value of <code>H5P_DEFAULT</code> for
a property list value indicates that the library should use
- the default values for the appropriate property list. Also see
- <code>H5Fpublic.h</code> for the list of supported flags.
+ the default values for the appropriate property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>const char *</em><code>name</code>
<dd>Name of the file to access.
<dt><em>uintn</em> <code>flags</code>
- <dd>File access flags. Allowable values include:
+ <dd>File access flags. Allowable values are:
<ul><dl>
<dt>H5F_ACC_TRUNC
<dd>Truncate file, if it already exists,
erasing all data previously stored in the file.
<dt>H5F_ACC_EXCL
<dd>Fail if file already exists.
- <dt>H5F_ACC_DEBUG
- <dd>Print debug information.
- (Used only by HDF5 library developers.
- Do not use this flag in applications.)
</dl></ul>
- <code>H5F_ACC_TRUNC</code> and <code>H5F_ACC_EXCL</code>
+ <li><code>H5F_ACC_TRUNC</code> and <code>H5F_ACC_EXCL</code>
are mutually exclusive; use exactly one.
+ <li>An additional flag, <code>H5F_ACC_DEBUG</code>, prints debug
+ information. This flag is used only by HDF5 library
+ developers; it is neither tested nor supported
+ for use in applications.
<dt><em>hid_t</em> <code>create_id</code>
<dd>File creation property list identifier, used when modifying
default file meta-data.