.. highlightlang:: us

.. index:: nc_vardelete

.. _nc_vardelete:

nc_vardelete
============

.. us.tag  nc_vardelete ENGLISH NC_Var New560

:ref:`nc_vardelete` deletes a given variable. A variable can only be deleted if
the file is not in definition mode.

.. function::  ret = nc_vardelete(ncid, ssName)

.. us.return

**Return Value**

*ret* is -1 if an error occurs, otherwise *ret* is 1.

.. us.params

**Parameters**

.. uparam:: ncid

   Identifies the netCDF file.

.. uparam:: ssName

   *ssName* is the name of the netCDF variable.

.. us.comment

**Comment**

This function can only be used for UniPlot data files (.nc2). See
:ref:`nc_create`. For netCDF-files (NC_FORMAT_CLASSIC and NC_FORMAT_PC) the
function always returns -1.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - 5.6.0
     - New.

.. seealso::
   :ref:`overview-netcdf-files`,
   :ref:`nc_create`,
   :ref:`nc_redef`

:sub:`id-171309`