.. highlightlang:: us

.. index:: nc_get_option

.. _nc_get_option:

nc_get_option
=============

.. us.tag  nc_get_option ENGLISH NC New403 Changed542 Changed5145 Changed5508 Changed6200

:ref:`nc_get_option` gets an option.

.. function::  prop = nc_get_option(ncid, ssPropName)

.. us.return

**Return Value**

*prop* is the property value or -1 if an error occurred.

.. us.params

**Parameters**

.. uparam:: ssPropName

   *ssPropName* is one of the following values:

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

      * - Value
        - Meaning
      * - ``"nocase"``
        - Boolean value. TRUE (default = 1) indicates that variable and attribute
          names :ref:`nc_varid` and :ref:`nc_attget` should be treated 
          case-sensitively.  FALSE (0) indicates that upper- and lower-case 
          characters should be treated equally.
      * - ``"umlaut_to_underscore"``
        - Boolean value. If set to 1 umlauts in channel- and attribute names are
          replaced by an underscore. If set to 0 umlauts are replaced as 
          following: Ä->A, ä->a, Ö->O, ö->o, Ü->U, ü->u, ß->s. Default value 
          is 0. Because of a bug in UniPlot 5.0.0 to 5.4.1 Umlauts were always 
          replaced by an underscore. With the help of this option this behavior 
          can be reset. The option can only be set globally (ncid = -1).
      * - ``"allow_special_chars"``
        - Boolean value (default = 1). If *prop* is 1 the following 10 
          charaters may occur in channel and attribute names: ``.``, ``-``, 
          ``+``, ``$``, ``#``, ``~``, ``!``, ``^``, ``&``, ``%``.
      * - ``"nc2_no_write_share"``
        - see :ref:`nc_set_option`.
      * - ``"utf8"``
        - see :ref:`nc_set_option`.

.. us.example

**Example**

::

   print nc_get_option(ncid, "nocase");

.. us.history

**History**

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

   * - Version
     - Description
   * - R2020.0
     - New Option ``"utf8"``.
   * - R2013.8
     - New Option ``"nc2_no_write_share"``.
   * - 5.14.5
     - New property ``"allow_special_chars"``.
   * - 5.4.2
     - New property ``"umlaut_to_underscore"``.

.. seealso::
   :ref:`overview-netcdf-files`,
   :ref:`nc_open`,
   :ref:`nc_set_option`

:sub:`id-243621`