.. highlightlang:: us

.. index:: ExcelWrite

.. _excelwrite:

ExcelWrite
==========

.. us.tag  ExcelWrite ENGLISH

The :ref:`ExcelWrite` function saves data in an Excel file format.

.. function::  bool = ExcelWrite(ssFileName, smMatrix, smType)
    bool = ExcelWrite(ssFileName, smMatrix)
    bool = ExcelWrite(ssFileName, rmMatrix)

.. us.return

**Return Value**

If the function succeeds, the return value is TRUE (1);
otherwise it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: ssFileName

   *ssFileName* is the complete file name, which usually has the extension
   :file:`.XLS`. 

.. uparam:: smType

   *smType* is a string matrix that defines the type of the corresponding
   elements in the parameter *smMatrix*.

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

      * - Value
        - Meaning
      * - ``"I"``
        - The corresponding element in smMatrix will be converted into a 16 bit
          unsigned integer number.
      * - ``""`` (empty string)
        - The corresponding element in smMatrix will be converted into a real
          number.
      * - ``"S"``
        - The corresponding element in smMatrix will be written as a string.

.. uparam:: smMatrix

   *smMatrix* is a string matrix.

.. uparam:: rmMatrix

   *rmMatrix* is a real matrix.

.. us.comment

**Comment**

The maximum number of rows is limited to 16384 and the maximum number of columns
is limited to 255. :ref:`ExcelWriteEx` can write XLSX Excel files with up to one 
millon data rows.

.. seealso::
   :ref:`overview-excel-files`,
   :ref:`ExcelRead`,
   :ref:`ExcelWriteEx`

:sub:`id-1241313`