PIO  2.5.4
Functions
Rename an Attribute

Rename an attribute in C. More...

Functions

int PIOc_rename_att (int ncid, int varid, const char *name, const char *newname)
 The PIO-C interface for the NetCDF function nc_rename_att. More...
 

Detailed Description

Rename an attribute in C.

Function Documentation

◆ PIOc_rename_att()

int PIOc_rename_att ( int  ncid,
int  varid,
const char *  name,
const char *  newname 
)

The PIO-C interface for the NetCDF function nc_rename_att.

This routine is called collectively by all tasks in the communicator ios.union_comm. For more information on the underlying NetCDF commmand please read about this function in the NetCDF documentation at: http://www.unidata.ucar.edu/software/netcdf/docs/group__attributes.html

Parameters
ncidthe ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile().
varidthe variable ID.
namethe name of the attribute.
newnamethe new name for the attribute.
Returns
PIO_NOERR for success, error code otherwise. See

PIOc_Set_File_Error_Handling().

Author
Jim Edwards, Ed Hartnett