.. highlightlang:: us

.. _fgetline:

fgetline
========

.. index:: fgetline

.. us.tag  fgetline ENGLISH ffiles Changed500 Changed5100

The :ref:`fgetline` function reads a string from the input file and stores it in a
string.

.. function::  ssString = fgetline(fh)

.. us.return

**Return Value**

*ssString* is a scalar string. In case of an error or at the end of file, an
empty string is returned.

.. us.params

**Parameters**

.. uparam:: fh

   *fh* is a file handle created by calling the :ref:`fopen` function.

.. us.comment

**Comment**

The newline character, if read, is included in the string. The function reads
from the current position to the end of the line. The line length is not limited.

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.0.0
     - As in UniPlot 4.x only 8-bit character sets can be read.

.. seealso::
   :ref:`overview-binary-and-text-files`,
   :ref:`fopen`,
   :ref:`fseek`,
   :ref:`feof`

:sub:`id-963517`