4.18 NF_RENAME_VAR

The function NF_RENAME_VAR changes the name of a netCDF variable in an open netCDF dataset. If the new name is longer than the old name, the netCDF dataset must be in define mode. You cannot rename a variable to have the name of any existing variable.

Usage

     INTEGER FUNCTION NF_RENAME_VAR (INTEGER NCID, INTEGER VARID,
                                     CHARACTER*(*) NEWNAM)

NCID

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

VARID

Variable ID.

NAME

New name for the specified variable.

Errors

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

• The new name is in use as the name of another variable.
• The variable ID is invalid for the specified netCDF dataset.
• The specified netCDF ID does not refer to an open netCDF dataset.

Example

Here is an example using NF_RENAME_VAR to rename the variable rh to rel_hum in an existing netCDF dataset named foo.nc:

     INCLUDE 'netcdf.inc'
        ...
     INTEGER  STATUS, NCID
     INTEGER  RHID             ! variable ID
        ...
     STATUS = NF_OPEN ('foo.nc', NF_WRITE, NCID)
     IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
        ...
     STATUS = NF_REDEF (NCID)  ! enter definition mode
     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)
     STATUS = NF_RENAME_VAR (NCID, RHID, 'rel_hum')
     IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
     STATUS = NF_ENDDEF (NCID) ! leave definition mode
     IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)