.. highlightlang:: us

.. index:: ExcelRead

.. _excelread:

ExcelRead
=========

.. us.tag  ExcelRead GERMAN

:ref:`ExcelRead` liest Dateien die im Excel-Format vorliegen. Die Dateien haben
i. allg. die Dateinamenserweiterung .xls.

.. function::  smMatrix = ExcelRead(ssFileName)
    smMatrix = ExcelRead(ssFileName, ssSheetName)
    <smMatrix, smType> = ExcelRead(ssFileName)
    <smMatrix, smType> = ExcelRead(ssFileName, ssSheetName)
    <smMatrix, smType> = ExcelRead(ssFileName, nSheet)
    <rmData, smString, smType> = ExcelRead(ssFileName)
    <rmData, smString, smType> = ExcelRead(ssFileName, ssSheetName)
    <rmData, smString, smType> = ExcelRead(ssFileName, nSheet)
    <rmData, smString, smType> = ExcelRead(ssFileName, nSheet, hStatusWnd)
    <rmData, smString, smType> = ExcelRead(ssFileName, ssSheetName, hStatusWnd)

.. us.return

**Returnwert**

*smMatrix* enthält die Daten der Exceltabelle als String-Matrix. Falls ein Fehler
beim Lesen der Datei auftritt, hat *smMatrix* den skalaren Wert ``""`` 
(leerer String). *rmData* ist eine reelle Matrix. Falls das Element der
Typ-Matrix *smType* den Typ ``"S"`` oder ``"B"`` hat, hat das entsprechende
Element in *rmData* den Wert 0.0.

*smString* ist eine String-Matrix. Falls das Element der Typ-Matrix *smType* den
Typ ``""`` oder ``"B"`` hat, hat das entsprechende Element in *smString* den Wert
``""`` (leerer String).

*smType* ist eine Stringmatrix, deren Elemente den Datentyp der entsprechenden
Zellen der Tabelle enthalten. Die Elemente können einen der folgenden Werte
annehmen:

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

   * - Wert
     - Bedeutung
   * - ``""``
     - Das Feld der Tabelle ist eine Zahl
   * - ``"S"``
     - Das Feld der Tabelle ist eine Zeichenkette (String)
   * - ``"B"``
     - Das Feld der Tabelle ist leer

.. us.params

**Parameter**

.. uparam:: ssFileName

   *ssFileName* ist der Name der zu lesenden Datei,
   z. B.: :file:`c:\\excel\\test.xls`.

.. uparam:: ssSheetName

   *ssSheetName* ist der Name der Tabelle (erst ab Excel 5.0 Dateien).

.. uparam:: nSheet

   *nSheet* ist der Index der Tabelle (erst ab Excel 5.0 Dateien).

.. uparam:: hStatusWnd

   Ist die Zugriffsnummer des Statusfensters, zur Ausgabe einer
   Fortschrittsanzeige (Defaultwert ist 0). Die Zugriffsnummer kann mit der
   Funktion :ref:`AppGetStatusBarHandle` erfragt werden.

.. us.comment

**Kommentar**

Alle Ausgabeparameter haben die gleiche Anzahl an Zeilen und Spalten. Auf eine
Tabelle einer Excel 5.0 Datei kann entweder über den Tabellen-Namen *ssSheetName*
oder einen Index zugegriffen werden (*nSheet*).

Wenn ein Fehler auftritt, haben die Ausgabeparameter nur ein Element mit dem Wert
0.0 bzw. ``""`` (leerer String).

Der Text einer Zelle ist auf 2048 Zeichen begrenzt. Längere Text werden nach 2048
Zeichen abgeschnitten. 

.. us.example

**Beispiel**

::

   <rmData, smMat, smType> = ExcelRead("test1.xls")
   if (smType[1] == "" && len(smType) == 1) {
       MessageBox("test1.xls - Lesefehler");
   }

.. seealso::
   :ref:`uberblick-excel-dateien`,
   :ref:`ExcelRead3`,
   :ref:`ExcelWrite`,
   :ref:`ExcelGetSheetNames`,
   :ref:`IsFileExcel`

:sub:`id-1624412`