.. highlight:: us

.. index:: ColorScale_DeleteUser

.. _colorscale_deleteuser:

ColorScale_DeleteUser
=====================

.. us.tag ColorScale_DeleteUser New6805

:ref:`ColorScale_DeleteUser` deletes a user color map.

.. function::  bool = ColorScale_DeleteUser(ssName)

.. us.return

**Return Value**

*bool* is TRUE (1) if the color map has been deleted and FALSE (0) if no user
color map with the given name exists or the file could not be saved.

.. us.params

**Parameters**

.. uparam:: ssName

   *ssName* is the name of the user color map. Predefined color maps cannot be
   deleted.

.. us.example

**Example**

::

   ColorScale_DeleteUser("MynewColorMap");

.. us.history

**History**

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

   * - Version
     - Description
   * - R2026.5
     - New.

.. seealso::
   :ref:`tools-user-color-maps`,
   :ref:`ColorScale_AddUser`,
   :ref:`ColorScale_GetUserNames`

:sub:`id-725423`