summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2016-01-28 18:58:59 (GMT)
committerScot Breitenfeld <brtnfld@hdfgroup.org>2016-01-28 18:58:59 (GMT)
commita969fbf6040707b4d4b099a7b2c19be787908230 (patch)
tree9101e813de4710c5d4d9f3d53ac1bf8c3bdd848b
parenta6da81e49ba88fac85b5a77759b738dfbdc7eb62 (diff)
downloadhdf5-a969fbf6040707b4d4b099a7b2c19be787908230.zip
hdf5-a969fbf6040707b4d4b099a7b2c19be787908230.tar.gz
hdf5-a969fbf6040707b4d4b099a7b2c19be787908230.tar.bz2
[svn-r29009] Corrected the API descriptions for H5Pget_virtual_dsetname and H5Pget_virtual_filename.
-rw-r--r--src/H5Pdcpl.c14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/H5Pdcpl.c b/src/H5Pdcpl.c
index 2abd24c..c60e4b0 100644
--- a/src/H5Pdcpl.c
+++ b/src/H5Pdcpl.c
@@ -2517,8 +2517,8 @@ done:
*
* If the length of the filename, which determines the
* required value of size, is unknown, a preliminary call to
- * H5Pget_virtual_filename with the last two parameters set
- * to NULL can be made. The return value of this call will
+ * H5Pget_virtual_filename with 'name' set to NULL and 'size'
+ * set to zero can be made. The return value of this call will
* be the size in bytes of the filename. That value, plus 1
* for a NULL terminator, is then assigned to size for a
* second H5Pget_virtual_filename call, which will retrieve
@@ -2578,14 +2578,14 @@ done:
* additional characters, if any, are not returned to the
* user application.
*
- * If the length of the filename, which determines the
+ * If the length of the dataset name, which determines the
* required value of size, is unknown, a preliminary call to
- * H5Pget_virtual_dsetname with the last two parameters set
- * to NULL can be made. The return value of this call will
- * be the size in bytes of the filename. That value, plus 1
+ * H5Pget_virtual_dsetname with 'name' set to NULL and 'size'
+ * set to zero can be made. The return value of this call will
+ * be the size in bytes of the dataset name. That value, plus 1
* for a NULL terminator, is then assigned to size for a
* second H5Pget_virtual_dsetname call, which will retrieve
- * the actual filename.
+ * the actual dataset name.
*
* Return: Returns the length of the name if successful, otherwise
* returns a negative value.