.. highlightlang:: us

.. _xyzinsertlabel:

XYZInsertLabel
==============

.. index:: XYZInsertLabel

.. us.tag  XYZInsertLabel ENGLISH XYZSet_label Changed500

:ref:`XYZInsertLabel` lables isolines with their z-values.

.. function::  bool = XYZInsertLabel(hData, rvP1P2)

.. 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:`XYZCreate`.

.. uparam:: rvP1P2

   *rvP1P2* is a vector with 4 elements:

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

   * - Value
     - Meaning
   * - rvP1P2[1]
     - x-coordinate from point 1 (P1)
   * - rvP1P2[2]
     - y-coordinate from point 1 (P1)
   * - rvP1P2[3]
     - x-coordinate from point 2 (P2)
   * - rvP1P2[4]
     - y-coordinate from point 2 (P2)

The coordinates will be entered as world coordinates. The lables will
be inserted at the intersection points of the isolines and the
straight line between P1 and P2

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.0.0
     - The function will switch to user labels, see :ref:`XYZSetLabelTypeIsolines`.

.. seealso::
   :ref:`overview-xyz-datasets`,
   :ref:`XYZCreate`,
   :ref:`XYZDeleteLabel`,
   :ref:`XYZSetLabelTypeIsolines`

:sub:`id-128941`