summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-12-17 15:39:46 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-12-17 15:39:46 (GMT)
commit620c3d380d72addd9e141a1c60d931bd7cf3f8dc (patch)
tree937af9eeb253b4d175a556d535474502975de2bb /doc
parent654dfafca67958eb01fffcb5f840919e78bd641c (diff)
downloadhdf5-620c3d380d72addd9e141a1c60d931bd7cf3f8dc.zip
hdf5-620c3d380d72addd9e141a1c60d931bd7cf3f8dc.tar.gz
hdf5-620c3d380d72addd9e141a1c60d931bd7cf3f8dc.tar.bz2
[svn-r1889] 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.html29
2 files changed, 20 insertions, 16 deletions
diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html
index 63753c3..94ba4f5 100644
--- a/doc/html/RM_H5D.html
+++ b/doc/html/RM_H5D.html
@@ -150,6 +150,11 @@ facilitate moving easily between them.</i>
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.
@@ -399,7 +404,7 @@ facilitate moving easily between them.</i>
<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 b4f3044..27843b8 100644
--- a/doc/html/RM_H5F.html
+++ b/doc/html/RM_H5F.html
@@ -159,19 +159,19 @@ facilitate moving easily between them.</i>
<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
@@ -217,27 +217,26 @@ facilitate moving easily between them.</i>
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; <i>it is neither tested nor supported</i>
+ 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.
@@ -553,7 +552,7 @@ facilitate moving easily between them.</i>
<dt><strong>Purpose:</strong>
<dd>Reopens an HDF5 file.
<dt><strong>Description:</strong>
- <code>H5Freopen</code> reopens an HDF5 file. The new
+ <dd><code>H5Freopen</code> reopens an HDF5 file. The new
file identifier which is returned points to the same file
as the specified file idetifier, <code>file_id</code>.
Both identifiers share caches and other information.