.. highlightlang:: us

.. index:: ftf_open

.. _ftf_open:

ftf_open
========

.. us.tag  ftf_open NOTREADYENGLISH ftf New590 Changed5511

:ref:`ftf_open` reads text files (ASCII) containing rows and columns of text,
numbers and empty fields. The function can be used instead of :ref:`FileToField`.
:ref:`ftf_open` can read large data files with hundreds of Megabytes.

.. function::  context = ftf_open(ssName, ssFieldSep, ssDecimalSep, ssRecordSep, hStatusWnd, bQuotedNumberConversion)
               context = ftf_open(ssName, ssFieldSep, ssDecimalSep, ssRecordSep, hStatusWnd, bQuotedNumberConversion, iStartPos)
               context = ftf_open(ssName, options)

.. us.return

**Return Value**

*context*.

.. us.params

**Parameters**

See :ref:`FileToField`.

.. uparam:: context

   Object with parametern. Default parameters are::
 
      options = [.  ssFieldSep = ";", 
                    ssDecimalSep = ".",
                    ssRecordSep = "\n",
                    hStatusWnd = AppGetStatusBarHandle(), 
                    bQuotedNumberConversion = FALSE,
                    iStart = 0];

.. us.example

**Example**

::

   def test()
   {
       ssDecimalSep = ",";
       ssFieldSep = ";";
       ssRecordSep = "\n";
       hStatusWnd = AppGetStatusBarHandle();
       bQuotedNumberConversion = FALSE;
       ssName = "Z:\\UniPlot-TestData\\ABS_00001.dat.utx";
   //    <rmMat, smMat, smType> = FileToField(ssName, ssFieldSep, ssDecimalSep, ..
   //            ssRecordSep, hStatusWnd, bQuotedNumberConversion);
       o = ftf_open(ssName, ssFieldSep, ssDecimalSep, ssRecordSep, hStatusWnd, ..
                    bQuotedNumberConversion);
       rvSize = ftf_get_size(o);
       while (1) {
           nRead = ftf_get_rows(o, 100);
           if (nRead == 0) {
               break;
           }
           print t = ftf_get_row_type(o);
           print v = ftf_get_row_num(o);
           print s = ftf_get_row_str(o);
       }
       ftf_close(o);
   }
   test()

.. us.history

**History**

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

   * - Version
     - Description
   * - R2013.11
     - New parameter *iStartPos* und Übergabe der Parameter als Objekt.
   * - 5.9.0
     - New

.. seealso::
   :ref:`overview-binary-and-text-files`,
   :ref:`FileToField`,
   :ref:`ftf_open`,
   :ref:`ftf_close`,
   :ref:`ftf_get_size`,
   :ref:`ftf_get_rows`,
   :ref:`ftf_get_row_type`,
   :ref:`ftf_get_row_num`,
   :ref:`ftf_get_row_str`,
   :ref:`ftf_rewind`

:sub:`id-79884`