.. highlightlang:: us

.. index:: GetDirectory

.. _getdirectory:

GetDirectory
============

.. us.tag  GetDirectory GERMAN FILE_MISC New300 Changed411

:ref:`GetDirectory` liefert einen String-Vektor von vollständigen Dateinamen. 
Falls *bRecurseSubDirs* TRUE (1) ist, werden auch Unterverzeichnisse durchsucht. 
Die Funktion liefert keine Verzeichnisnamen.

.. function::  svFileNames = GetDirectory(ssSearch)
    svFileNames = GetDirectory(ssSearch, bRecurseSubDirs)
    svFileNames = GetDirectory(ssSearch, bRecurseSubDirs, ssCallback)

.. us.return

**Returnwert**

*svFileNames* Falls keine Dateien gefunden werden liefert :ref:`GetDirectory`
einen leeren String.

.. us.params

**Parameter**

.. uparam:: ssSearch

   *ssSearch* ist ein Muster das Wildcards wie ``"*"`` oder ``"?"`` enthalten
   kann (z. B. ``"*.xls"``).

.. uparam:: bRecurseSubDirs

   Falls *bRecurseSubDirs* TRUE (1) ist, werden alle Unterverzeichnisse in die
   Suche eingeschlossen. Default-Wert ist FALSE (0).

.. uparam:: ssCallback

   Name der vom Anwender bereitzustellenden Callback-Funktion, die für jede
   gefundene Datei aufgerufen wird. Die Funktion besitzt 3 Parameter::

      my_dir_callback(bDir, ssFile, files)

   **bDir**: TRUE falls der zweite Parameter ein Verzeichnisname ist und sonst
   FALSE.

   **ssFile**: Name einer Datei oder eines Verzeichnisses.

   **files**: Ein mit :ref:`obj_create` erzeugtes Objekt, in das die Namen der
   Dateien eingetragen werden.

.. us.example

**Beispiel**

Der folgende Aufruf, erzeugt einen Stringvektor aller IPW-Dateien des Laufwerks
:file:`C:`. Achtung: Wenn sich viele Dateien auf dem Laufwerk :file:`C:`
befinden, kann der Aufruf lange dauern.

::

   * GetDirectory("c:/programme/uniplot/samples/*.ipw", 1)
   c:/programme/uniplot/samples/sample.ipw
   c:/programme/uniplot/samples/template.ipw
   c:/programme/uniplot/samples/automate/example.ipw
   c:/programme/uniplot/samples/automate/vollast.ipw

Der folgende Aufruf zeigt die Verwendung einer Callback-Funktion::

   def my_dir_callback(bDir, ssFile, files)
   {
       if (bDir) {
           AppSetStatusBarText(ssFile);
       } else {
           files[ssFile] = 1;
       }
   }

::

   * GetDirectory("c:/programme/uniplot/samples/*.ipw", 1, "my_dir_callback")
   c:/programme/uniplot/samples/sample.ipw
   c:/programme/uniplot/samples/template.ipw
   c:/programme/uniplot/samples/automate/example.ipw
   c:/programme/uniplot/samples/automate/vollast.ipw

.. seealso::
   :ref:`uberblick-dateien`,
   :ref:`FindFiles`,
   :ref:`GetFileAttributes`,
   :ref:`SplitPath`

:sub:`id-1233954`