.. highlightlang:: us

.. index:: XYSetLegendText

.. _xysetlegendtext:

XYSetLegendText
===============

.. us.tag  XYSetLegendText GERMAN XYSet

:ref:`XYSetLegendText` setzt den Legendentext für einen 1D oder 2D Datensatz.

.. function::  bool = XYSetLegendText(hData, ssText)

.. us.return

**Returnwert**

*bool* ist TRUE (1), wenn die Funktion erfolgreich war und sonst FALSE (0). Falls
der Legendentext geschützt ist, wird der Text nicht aktualisiert und die
Funktion liefert Wert FALSE zurück.

.. us.params

**Parameter**

.. uparam:: hData

   *hData* ist die Zugriffsnummer (Handle) des Datensatzes, der mit
   :ref:`XYCreate` oder :ref:`TYCreate` erzeugt wurde.

.. uparam:: ssText

   *ssText* ist der Legendentext. Wenn der Legendentext mit eine 
   Ausrufungszeichen (!) beginnt, wird der Datensatz nicht in der Legende 
   ausgegeben und auch nicht im Achsentitel angezeigt.

.. us.comment

**Kommentar**

Die Feldfunktionen für Legenden verwenden den Legendentext. Soll der Text gesetzt
werden, kann vor dem Aufruf der Schutz des Legendentextes mit 
:ref:`XYProtectLegendText` aufgehoben werden.

.. seealso::
   :ref:`uberblick-xy-datensatze`,
   :ref:`XYCreate`,
   :ref:`XYGetLegendText`,
   :ref:`XYProtectLegendText`,
   :ref:`XYIsLegendTextProtected`

:sub:`id-1045080`