.. highlightlang:: us

.. index:: IsFileText

.. _isfiletext:

IsFileText
==========

.. us.tag  IsFileText ENGLISH FILE_MISC Changed500 Changed5100

:ref:`IsFileText` checks if a file is a text file (ASCII File).

.. function::  bool = IsFileText(ssFileName)

.. us.return

**Return Value**

*bool* is TRUE (1) if the file is a text file. If *bool* is FALSE (0) a
``"\0"`` character was found in the first 4096 characters of the file.

.. us.params

**Parameters**

.. uparam:: ssFileName

   *ssFileName* is the complete path name of the file.

.. us.comment

**Comment**

The function checks if the first 4 kBytes contains Null characters. If NULL
characters are found the function returns FALSE. The file is opened in read only
mode.

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.10.0
     - If the file contains a UNICODE BOM (byte order mark) the function returns TRUE.
   * - 5.0.0
     - The fuction cannot process Unicode files.

.. seealso::
   :ref:`IsFileExcel`,
   :ref:`IsFilenetCDF`,
   :ref:`GetFileAttributes`

:sub:`id-16930`