mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-11-27 02:10:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

[svn-r29009] Corrected the API descriptions for H5Pget_virtual_dsetname and H5Pget_virtual_filename.

Browse Source
This commit is contained in:
Scot Breitenfeld 2016-01-28 13:58:59 -05:00
parent a6da81e49b
commit a969fbf604
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/H5Pdcpl.c
View File

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