.. highlightlang:: us

.. _xygeterrorbarconfig:

XYGetErrorbarConfig
===================

.. index:: XYGetErrorbarConfig

.. us.tag  XYGetErrorbarConfig ENGLISH XYGet New400

:ref:`XYGetErrorbarConfig` returns the error bar settings.

.. function::  rvConfig = XYGetErrorbarConfig(hData, ssXY)

.. us.return

**Return Value**

*rvConfig* is a real vector with 5 elements:

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

   * - Value
     - Name
     - Description
   * - rvConfig[1]
     - Pen
     - Pen Handle that is used to draw the error bar.
   * - rvConfig[2]
     - LineWidthCap
     - Line width of the error bar cap in steps of 0.1 mm.
   * - rvConfig[3]
     - CapWidth
     - Width of the error bar cap in centimeters. If the width is 0 the cap is not drawn.
   * - rvConfig[4]
     - dValue
     - Error value. The meaning depends on the attribute value.
   * - rvConfig[5]
     - Attribut
     - See next table.

The element rvConfig[5] (Attribut) can be a combination of the following values: 

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

   * - Value
     - Name
     - Description
   * - ERRORBAR_PERCENT
     - 1
     - Error value in percent
   * - ERRORBAR_CONSTANT
     - 2
     - Absolut error value
   * - ERRORBAR_PLUS
     - 8
     - Draw positive error bar
   * - ERRORBAR_MINUS
     - 16
     - Draw negative error bar
   * - ERRORBAR_PLUSMINUS
     - 24
     - Draw positive and negative error bar.

.. us.params

**Parameters**

.. uparam:: hData

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

.. uparam:: ssXY

   *ssXY* is a scalare string. For "X" the configuration of the x-errorbars is returned
   and for "Y" the y errobar configuration.

.. us.comment

**Comment**

The function returns a copy of the used pen (rvConfig[1]). This pen must be deleted
with :ref:`PenDestroy` after it has been used to avoid memory leaks.

.. seealso::
   :ref:`overview-xy-datasets`,
   :ref:`XYCreate`,
   :ref:`XYSetErrorbarConfig`

:sub:`id-240846`