<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA - Serge STEER
 * ...
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="mgetl">
    <refnamediv>
        <refname>mgetl</refname>
        <refpurpose>считывает строки из текстового файла</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>txt = mgetl(file_desc [,m])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>file_desc</term>
                <listitem>
                    <para>
                        символьная строка, указывающая имя файла или логический блок, возвращаемый функцией <function>mopen</function>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>m</term>
                <listitem>
                    <para>
                        целочисленный скаляр: количество строк, которое нужно прочитать.
                        Значение по умолчанию равно -1.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>txt</term>
                <listitem>
                    <para>вектор-столбец строковых значений.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Описание</title>
        <para>
            Функция <function>mgetl</function> позволяет считывать строки из
            текстового файла.
        </para>
        <para>
            Если <varname>m</varname> не указано или равно <literal>-1</literal>,
            то будут считываться все строки до тех пор, пока не встретится конец
            файла.
        </para>
        <para>
            Если <varname>m</varname> указано, то функция <function>mgetl</function>
            пытается прочитать точно <varname>m</varname> строк. Эта опция полезна
            для последовательного чтения части файла. В этом случае, если конец
            файла встретится прежде, чем будет прочитано <varname>m</varname> строк,
            то прочитанные строки будут возвращены оформленными (можно проверять
            встретился ли конец файла используя функцию <function>meof</function>).
        </para>
        <para>
            Функция <function>mgetl</function> позволяет считывать файлы в
            операционных системах Unix, Windows или Mac.
        </para>
        <para>
            Функция <function>mgetl</function> поддерживает лишь кодировки UTF-8 и
            ANSI.
        </para>
    </refsection>
    <refsection>
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
mgetl('SCI/etc/scilab.start',5)

mgetl SCI/modules/elementary_functions/macros/erf.sci

fd=mopen('SCI/etc/scilab.start','r')
mgetl(fd,10)
mclose(fd)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="mputl">mputl</link>
            </member>
            <member>
                <link linkend="mclose">mclose</link>
            </member>
            <member>
                <link linkend="mfscanf">mfscanf</link>
            </member>
            <member>
                <link linkend="mget">mget</link>
            </member>
            <member>
                <link linkend="mput">mput</link>
            </member>
            <member>
                <link linkend="mgetstr">mgetstr</link>
            </member>
            <member>
                <link linkend="mopen">mopen</link>
            </member>
            <member>
                <link linkend="read">read</link>
            </member>
        </simplelist>
    </refsection>
</refentry>

