.. highlightlang:: us

.. index:: XYReload

.. _xyreload:

XYReload
========

.. us.tag  XYReload ENGLISH XYSet New590 Changed5200 Changed5400

:ref:`XYReload` loads data.

.. function::  	bool = XYReload(hData)
				bool = XYReload(hData, nOptions)
				bool = XYReload(hData, nOptions, ncid)

.. us.return

**Return Value**

*bool*

.. us.params

**Parameters**

.. uparam:: hData

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

.. uparam:: nOptions

   .. list-table::
      :header-rows: 0

      * - ``XY_RELOAD_UPDATE (0)``
        - Reload data if necessary.
      * - ``XY_RELOAD_CLIP (1)``
        - Reload data only for the x-axis range of the diagram.
      * - ``XY_RELOAD_ALL (2)``
        - Reload all data points.
      * - ``XY_RELOAD_FORCERELOAD (4)``
        - Force reload data.

.. uparam:: ncid

   *ncid* is a data file handle (see :ref:`nc_open`).

.. us.comment

**Comment**

The function opens the data file (:file:`*.nc2`) and loads the data for the
displayed x-range. If the file is not found in the specified directory, UniPlot
tries to find the file in the following directories:

* Directory of the IPW file.

* Directory specified in :ref:`toolsmore-options` "Data Import and Data Browser", 
  key "netCDF Data File Directory".

If the file cannot be located an error message is written to the event window.

.. us.history

**History**

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

   * - Version
     - Description
   * - R2012 (5.40.0)
     - Depending on the diagram section, the function loads data from the 
       reduced data file or the non reduced data file.
   * - 5.20
     - New optional parameters *nOptions* and *ncid*.
   * - 5.9
     - New.

.. seealso::
   :ref:`overview-xy-datasets`,
   :ref:`TYCreate`,
   :ref:`XYCreate`,
   :ref:`overview-data-file-informations-for-datasets`

:sub:`id-1004157`