.. highlightlang:: us

.. index:: LayerGetCursorPosition

.. _layergetcursorposition:

LayerGetCursorPosition
======================

.. us.tag  LayerGetCursorPosition ENGLISH LayerCursor

:ref:`LayerGetCursorPosition` returns the cursor position.

.. function::  rmPos = LayerGetCursorPosition(hLayer)

.. us.return

**Return Value**

*rmPos* is a real-Matrix with  three columns and 3 rows or the value 0 if the
cursor is disabled:

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

   * - Value
     - Meaning
   * - rmPos[1;1]
     - x position cursor 1
   * - rmPos[2;1]
     - x position cursor 2 (0.0 if only one cursor is displayed).
   * - rmPos[3;1]
     - Dataset handle.
   * - rmPos[1;2]
     - y position cursor 1
   * - rmPos[2;2]
     - y position cursor 2 (0.0 if only one cursor is displayed).
   * - rmPos[3;2]
     - Number of cursor (1 or 2).
   * - rmPos[1;3]
     - Index of nearest data point cursor1
   * - rmPos[2;3]
     - Index of nearest data point cursor2
   * - rmPos[3;3]
     - Interpolation (TRUE (1) or FALSE (0))

.. us.params

**Parameters**

.. uparam:: hLayer

   *hLayer* is the handle of a diagram (layer).

.. seealso::
   :ref:`overview-diagrams`,
   :ref:`LayerIsCursor`,
   :ref:`XYFind`

:sub:`id-1024692`