Rename a Variable

Rename a variable in C. More...

Functions
int	PIOc_rename_var (int ncid, int varid, const char *name)
	The PIO-C interface for the NetCDF function nc_rename_var. More...

Detailed Description

Rename a variable in C.

Function Documentation

PIOc_rename_var()

int PIOc_rename_var	(	int	ncid,
		int	varid,
		const char *	name
	)

The PIO-C interface for the NetCDF function nc_rename_var.

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__variables.html

Parameters

ncid	the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile().
varid	the variable ID.
name	the new name for the variable.

Returns

PIO_NOERR for success, error code otherwise. See

PIOc_Set_File_Error_Handling().

Author

Jim Edwards, Ed Hartnett