5.8 NF_DEL_ATT

The function NF_DEL_ATT deletes a netCDF attribute from an open netCDF dataset. The netCDF dataset must be in define mode.

Usage

INTEGER FUNCTION NF_DEL_ATT (INTEGER NCID, INTEGER VARID, CHARACTER*(*) NAME)

NCID

NetCDF ID, from a previous call to NF_OPEN or NF_CREATE.

VARID

ID of the attribute's variable, or NF_GLOBAL for a global attribute.

NAME

The name of the attribute to be deleted.

Errors

NF_DEL_ATT returns the value NF_NOERR if no errors occurred. Otherwise, the returned status indicates an error. Possible causes of errors include:

• The specified variable ID is not valid.
• The specified netCDF dataset is in data mode.
• The specified attribute does not exist.
• The specified netCDF ID does not refer to an open netCDF dataset.

Example

Here is an example using NF_DEL_ATT to delete the variable attribute Units for a variable rh in an existing netCDF dataset named foo.nc:

     INCLUDE 'netcdf.inc'
        ...
     INTEGER STATUS            ! error status
     INTEGER NCID              ! netCDF ID
     INTEGER RHID              ! variable ID
        ...
     STATUS = NF_OPEN ('foo.nc', NF_WRITE, NCID)
     IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
        ...
     STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
     IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
        ...
     ! delete attribute
     STATUS = NF_REDEF (NCID)  ! enter define mode
     IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
     STATUS = NF_DEL_ATT (NCID, RHID, 'Units')
     IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
     STATUS = NF_ENDDEF (NCID) ! leave define mode
     IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)