.. highlightlang:: us

.. index:: XYGetErrorData

.. _xygeterrordata:

XYGetErrorData
==============

.. us.tag  XYGetErrorData ENGLISH xy.data New6001

:ref:`XYGetErrorData` returns the error data as a matrix with two columns. 
The data is used to display error bars.

.. function::  rmError = XYGetErrorData(hData, ssXY)

.. us.return

**Return Value**

*rmError* is the 2 columned matrix of the data points. ``rmError[;1]`` contains 
the minus error and ``rmError[;2]`` the plus error. If the dataset does not 
contain any error values the function returns the scalar value 0.

.. us.params

**Parameters**

.. uparam:: hData

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

.. uparam:: ssXY

   *ssXY* is "X" for the x-error, "Y" for the y-error.

.. us.comment

**Comment**

If the function returns all error data. The positive error values are added 
to the data point and the minus error is subtracted from the data value.
An error value of 0 is not displayed. The number of data points is 
limited to 200,000. The number of error points must match the number
of data points in the dataset.

**History**

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

   * - Version
     - Description
   * - R2018.1
     - New.

.. seealso::
   :ref:`overview-xy-datasets`,
   :ref:`XYSetErrorData`,
   :ref:`XYCreate`,
   :ref:`XYSetData`,
   :ref:`XYSetGetOrgDataFlag`

:sub:`id-1771447`