.. highlightlang:: us

.. index:: FileWatchAdd

.. _filewatchadd:

FileWatchAdd
============

.. us.tag  FileWatchAdd GERMAN FILE_MISC New321 Changed5501

:ref:`FileWatchAdd` fügt eine Datei einer Liste von Dateien zu, die beobachtet
werden sollen. Falls das Betriebssystem feststellt, das die Datei geändert wurde,
wird die angegebene Callback-Funktion aufgerufen.

.. function::  bool = FileWatchAdd(ssFileName, ssCallback)
               bool = FileWatchAdd(ssFileName, ssCallback, rsData)

.. us.return

**Returnwert**

*bool* ist TRUE (1), falls die Funktion erfolgreich registriert werden konnte.

.. us.params

**Parameter**

.. uparam:: ssFileName

   Name mit vollständigem Pfad einer zu beobachtenden Datei.

.. uparam:: ssCallback

   Name einer Callback-Funktion, die aufgerufen wird, wenn die Datei geändert
   wurde. Die Callback-Funktion muss vom Anwender zur Verfügung gestellt werden.
   Der Funktion wird der vollständigen Dateiname als Parameter übergeben.

.. uparam:: rsData

   Eine Zahl, die an die Callback-Funktion übergeben wird.

.. us.example

**Beispiel**

::

   FileWatchAdd("c:/test.txt", "MyReloadFunction");

   def MyReloadFunction(ssFile)
   {
       // Do something with the file
       ....
   }

**Beispiel**

::

   FileWatchAdd("c:/test.txt", "MyReloadFunction", 123);

   def MyReloadFunction(ssFile, rsData)
   {
       // Do something with the file
       ....
   }
   
.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2013.1 (5.50.1)
     - Neuer Parameter *rsData*.
   * - 3.2.1
     - Neu.

.. seealso::
   :ref:`uberblick-binar--und-text-dateien`,
   :ref:`FileWatchRemove`

:sub:`id-679831`