.. highlightlang:: us

.. _xyusefilter:

XYUseFilter
===========

.. index:: XYUseFilter

.. us.tag  XYUseFilter xy.data New400

:ref:`XYUseFilter` specifies if the filter functions are used to calculate
the output data.

.. function::  bool = XYUseFilter(hData, bShowFiltered)

.. us.return

**Return Value**

*bool* is TRUE (1), when the function succeeds and FALSE (0), if it does not. 

.. us.params

**Parameters**

.. uparam:: hData

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

.. uparam:: bShowFilteredData

   *bShowFilteredData*.
   If *bShowFilteredData* is TRUE (1) the filtered data is displayed. If
   the value is FALSE (0), the original data is displayed.

.. us.example

**Example**

see :ref:`XYSetFilterFunctions`.

.. seealso::
   :ref:`overview-xy-datasets`,
   :ref:`XYIsFilterUsed`

:sub:`id-1860145`