.. highlightlang:: us

.. index:: XYProtectLegendText

.. _xyprotectlegendtext:

XYProtectLegendText
===================

.. us.tag  XYProtectLegendText ENGLISH XYSet New5600

:ref:`XYProtectLegendText` protects the legend text of a dataset.

.. function::  bool = XYProtectLegendText(hData, bProtect)

.. us.return

**Return Value**

If the function succeeds, the return value *bool* is TRUE (1); otherwise it is
FALSE (0).

.. us.params

**Parameters**

.. uparam:: hData

   The handle of a dataset created with :ref:`XYCreate` or :ref:`TYCreate`.

.. uparam:: bProtect

   If *bProtect* is TRUE (1), the dataset legend text is protected against 
   modification.

.. us.comment

**Comment**

**Comments**

If the option **Always update legend text of 1D and 2D datasets.**  in the 
dialog box :ref:`file-import-options` is disabled the legend text will never
be updated.

.. seealso::
   :ref:`overview-xy-datasets`,
   :ref:`XYIsSelected`,
   :ref:`XYCreate`,
   :ref:`XYSetLegendText`

:sub:`id-1702303`