mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2024-11-27 07:30:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

added return code documentation for dtype.c and datt.c

Browse Source
This commit is contained in:
Ed Hartnett 2017-11-15 04:08:58 -07:00
parent f6828b4b5e
commit ca45c203c5
2 changed files with 38 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
libdispatch/datt.c
View File

@ -1,10 +1,9 @@
/** \file
Attribute functions
Copyright 2010 University Corporation for Atmospheric
Research/Unidata. See \ref copyright file for more info.
These functions read and write attributes.
Copyright 2010 University Corporation for Atmospheric
Research/Unidata. See \ref copyright file for more info. */
*/
#include "ncdispatch.h"
@ -16,11 +15,11 @@ Attributes hold metadata about data and files.
Attributes may be associated with a netCDF variable to specify such
properties as units, special values, maximum and minimum valid values,
scaling factors, and offsets.
scaling factors, and offsets.
Attributes for a netCDF dataset are defined when the dataset is first
created, while the netCDF dataset is in define mode. Additional
attributes may be added later by reentering define mode.
attributes may be added later by reentering define mode.
A netCDF attribute has a netCDF variable to which it is assigned, a
name, a type, a length, and a sequence of one or more values.
@ -38,9 +37,10 @@ more space than the attribute as originally defined.
It is also possible to have attributes that are not associated with
any variable. These are called global attributes and are identified by
using ::NC_GLOBAL as a variable pseudo-ID. Global attributes are usually
related to the netCDF dataset as a whole and may be used for purposes
such as providing a title or processing history for a netCDF dataset.
using ::NC_GLOBAL as a variable pseudo-ID. Global attributes are
usually related to the netCDF dataset as a whole and may be used for
purposes such as providing a title or processing history for a netCDF
dataset.
Operations supported on attributes are:
- Create an attribute, given its variable ID, name, data type, length,
@ -102,6 +102,20 @@ dataset named foo.nc:
status = nc_rename_att(ncid, rh_id, "units", "Units");
if (status != NC_NOERR) handle_error(status);
\endcode
\returns NC_NOERR No error.
\returns ::NC_EBADID Bad ncid.
\returns ::NC_ENOTVAR Bad varid.
\returns ::NC_EBADNAME Bad name.
\returns ::NC_EMAXNAME New name too long.
\returns ::NC_EINVAL Name or new name not provided.
\returns ::NC_ENAMEINUSE Name already in use.
\returns ::NC_EPERM File was opened read only.
\returns ::NC_ENOTINDEFINE File is not in define mode.
\returns ::NC_ENOTATT Attribute not found.
\returns ::NC_EHDFERR Failure at HDF5 layer.
\returns ::NC_ENOMEM Out of memory.
\author Glenn Davis, Ed Hartnett, Dennis Heimbigner
*/
int
nc_rename_att(int ncid, int varid, const char *name, const char *newname)
@ -153,6 +167,17 @@ Units for a variable rh in an existing netCDF dataset named foo.nc:
status = nc_enddef(ncid);
if (status != NC_NOERR) handle_error(status);
\endcode
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad ncid.
\returns ::NC_ENOTVAR Bad varid.
\returns ::NC_EBADNAME Bad name.
\returns ::NC_EINVAL Name not provided.
\returns ::NC_EPERM File was opened read only.
\returns ::NC_ENOTINDEFINE File is not in define mode.
\returns ::NC_ENOTATT Attribute not found.
\returns ::NC_EATTMETA Failure at HDF5 layer.
\author Glenn Davis, Ed Hartnett, Dennis Heimbigner
*/
int
nc_del_att(int ncid, int varid, const char *name)

5
libdispatch/dtype.c
View File

@ -39,7 +39,7 @@ type). Read attributes of the new type with nc_get_att (see
/** \{ */
/** \internal
/**
\ingroup user_types
Learn if two types are equal
@ -55,6 +55,7 @@ the two types are equal, a zero if they are not equal.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
\author Dennis Heimbigner, Ward Fisher
*/
int
nc_inq_type_equal(int ncid1, nc_type typeid1, int ncid2,
@ -87,6 +88,7 @@ found.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
\author Ed Hartnett, Dennis Heimbigner
*/
int
nc_inq_typeid(int ncid, const char *name, nc_type *typeidp)
@ -130,6 +132,7 @@ compound types. \ref ignored_if_null.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
\author Ed Hartnett, Dennis Heimbigner
*/
int
nc_inq_user_type(int ncid, nc_type xtype, char *name, size_t *size,