.. highlightlang:: us

.. _excel_open:

excel_open
==========

.. index:: excel_open

.. us.tag  excel_open NOTREADYENGLISH excel excel-read New550

:ref:`excel_open` opens an Excel file for reading.

.. function::  oExcel = excel_open(ssFile)

.. us.return

**Return Value**

*oExcel* is an UniScript object or 0 if an error occurred.

.. us.params

**Parameters**

.. uparam:: ssFile

   *ssFile* is the complete file name.

.. us.comment

**Comment**

To close the Excel file invoke :ref:`excel_close`.

.. us.example

**Example**

::

   def MyExcelRead(ssName)
   {
       oExcel = excel_open(ssName);
       if (oExcel == 0) {
           MessageBoxError("Cannot open file %s", ssName);
           return "";
       }
       oSheet = excel_sheet_open(oExcel, 1); // open the first sheet.
       rvSize = excel_sheet_get_size(oSheet);
       nRead = excel_sheet_get_rows(oSheet, 100); // read the first 100 rows
       rmType = excel_sheet_get_row_type(oSheet);
       rmData = excel_sheet_get_row_num(oSheet);
       rmString = excel_sheet_get_row_str(oSheet);
       excel_sheet_close(oSheet);
       excel_close(oExcel);
       return rmString;
   }

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.5.0
     - New

.. seealso::
   :ref:`overview-excel-files`
   :ref:`excel_sheet_open`,
   :ref:`excel_get_sheetnames`,
   :ref:`excel_get_style_index`,
   :ref:`excel_get_style_map`,
   :ref:`excel_sheet_close`,
   :ref:`excel_sheet_get_rows`,
   :ref:`excel_sheet_get_row_num`,
   :ref:`excel_sheet_get_row_str`,
   :ref:`excel_sheet_get_row_style`,
   :ref:`excel_sheet_get_row_type`,
   :ref:`excel_close`

:sub:`id-1565306`