.. highlightlang:: us

.. _excel_sheet_get_rows:

excel_sheet_get_rows
====================

.. index:: excel_sheet_get_rows

.. us.tag  excel_sheet_get_rows NOTREADYENGLISH excel-read New550

:ref:`excel_sheet_get_rows` reads the specified number of rows starting at
the current position. The current position is updated by the number of
rows read. To fetch the data use :ref:`excel_sheet_get_row_num`,
:ref:`excel_sheet_get_row_str` and :ref:`excel_sheet_get_row_str`.

.. function::  nRows = excel_sheet_get_rows(oSheet, nRowsToRead)

.. us.return

**Return Value**

*nRows* is the number of full rows actually read. It may be less than 
*nRowsToRead* if the end of the sheet is reached. If an error occurs the 
function returns 0.

.. us.params

**Parameters**

.. uparam:: oSheet

   *oSheet* is an object created by :ref:`excel_sheet_open`.

.. uparam:: nRowsToRead

   Is the max. number of rows to read.

.. us.example

**Example**

See :ref:`excel_open`.

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.5.0
     - New

.. seealso::
   :ref:`overview-excel-files`,
   :ref:`excel_open`,
   :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_row_num`,
   :ref:`excel_sheet_get_row_str`,
   :ref:`excel_sheet_get_row_style`,
   :ref:`excel_sheet_get_row_type`

:sub:`id-1000235`