PIO  2.5.4
Functions
Rename a Dimension

Rename a dimension in C. More...

Functions

int PIOc_rename_dim (int ncid, int dimid, const char *name)
 The PIO-C interface for the NetCDF function nc_rename_dim. More...
 

Detailed Description

Rename a dimension in C.

Function Documentation

◆ PIOc_rename_dim()

int PIOc_rename_dim ( int  ncid,
int  dimid,
const char *  name 
)

The PIO-C interface for the NetCDF function nc_rename_dim.

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

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

PIOc_Set_File_Error_Handling().

Author
Jim Edwards, Ed Hartnett