mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2025-02-23 16:59:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated documentation of nc_inq_var_deflate() to describe behavior of deflate_level when deflate not in use

Browse Source
This commit is contained in:
Edward Hartnett 2020-03-17 10:33:53 -06:00
parent edea5e3552
commit 9b6215936b
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
libdispatch/dvarinq.c
View File

@ -258,8 +258,6 @@ nc_inq_varnatts(int ncid, int varid, int *nattsp)
/** \ingroup variables
Learn the storage and deflate settings for a variable.
This is a wrapper for nc_inq_var_all().
\param ncid NetCDF or group ID, from a previous call to nc_open(),
nc_create(), nc_def_grp(), or associated inquiry functions such as
nc_inq_ncid().
@ -274,12 +272,15 @@ function will write a 1 if the deflate filter is turned on for this
variable, and a 0 otherwise. \ref ignored_if_null.
\param deflate_levelp If the deflate filter is in use for this
variable, the deflate_level will be written here. \ref ignored_if_null.
variable, the deflate_level will be written here. If deflate is not in
use, and deflate_levelp is provided, it will get a zero. (This
behavior is expected by the Fortran APIs). \ref ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_ENOTNC4 Not a netCDF-4 file.
\returns ::NC_EBADID Bad ncid.
\returns ::NC_ENOTVAR Invalid variable ID.
\author Ed Hartnett, Dennis Heimbigner
*/
int
nc_inq_var_deflate(int ncid, int varid, int *shufflep, int *deflatep, int *deflate_levelp)