<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 * Copyright (C) 2010 - Digiteo - Vincent LIARD
 * ...
 *
 * 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:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mgetstr" xml:lang="ru">
    <refnamediv>
        <refname>mgetstr</refname>
        <refpurpose>считывает символьную строку из файла</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>str = mgetstr(n, [fd])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>n</term>
                <listitem>
                    <para>
                        неотрицательное целое число: количество символов, которое
                        необходимо прочитать.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>fd</term>
                <listitem>
                    <para>
                        целое число: дескриптор файла, возвращаемый функцией
                        <link linkend="mopen">mopen</link>, в котором необходимо
                        прочитать символы. Значение <literal>-1</literal> ставится для
                        последнего открытого файла и оно является значением по умолчанию.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>str</term>
                <listitem>
                    <para>символьная строка, которую нужно прочитать.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Описание</title>
        <para>
            Функция <function>mgetstr</function> пытается прочитать
            <varname>n</varname> символов из файла. Если конец файла достигнут
            прежде, чем будут прочитаны <varname>n</varname> символов, то
            <function>mgetstr</function> возвращает лишь те значения, которые
            удалось прочитать. Как следствие, когда курсор чтения уже в конце файла,
            когда вызывается функция <function>mgetstr</function>, то она возвращает
            пустую строку, и при этом не важно  какое значение указано для
            <varname>n</varname>.
        </para>
    </refsection>
    <refsection>
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
      fn = SCI + '/ACKNOWLEDGEMENTS'; // абсолютный пут до некоторого файла
      details = fileinfo(fn);         // получение деталей о файле
      len = details(1);               // получение длины файла
      fd = mopen(fn, 'rt');           // открыть файл как текст в режиме чтения
      str1 = mgetstr(33, fd)          // прочитать 33 символа из fd
      length(str1)                    // чтение 33 символов
      str2 = mgetstr(272, fd)         // чтение следующих 272 символов из fd
      length(str2)                    // 272 прочитанных символа
      mseek(len - 5);                 // прыжок на 5-тый символ до конца файла
      str3 = mgetstr(10, fd)          // попытка прочесть 10 символов: возвращаются только 5 символов, больше не доступно
      length(str3)                    // да, есть 5 символов: вы просто не видите символ перевода строки :)
      str4 = mgetstr(10, fd)          // чтение 10 символов: возврат пустой строки
      length(str4)                    // пустая строка
      mclose(fd);                     // закрытие файла
  ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="mclose">mclose</link>
            </member>
            <member>
                <link linkend="meof">meof</link>
            </member>
            <member>
                <link linkend="mfprintf">mfprintf</link>
            </member>
            <member>
                <link linkend="fprintfMat">fprintfMat</link>
            </member>
            <member>
                <link linkend="mfscanf">mfscanf</link>
            </member>
            <member>
                <link linkend="fscanfMat">fscanfMat</link>
            </member>
            <member>
                <link linkend="mget">mget</link>
            </member>
            <member>
                <link linkend="mopen">mopen</link>
            </member>
            <member>
                <link linkend="mprintf">mprintf</link>
            </member>
            <member>
                <link linkend="mput">mput</link>
            </member>
            <member>
                <link linkend="mputstr">mputstr</link>
            </member>
            <member>
                <link linkend="mseek">mseek</link>
            </member>
            <member>
                <link linkend="mtell">mtell</link>
            </member>
            <member>
                <link linkend="mdelete">mdelete</link>
            </member>
            <member>"Input/Output functions" section</member>
            <!-- TODO: link to "Input/Output functions" index page -->
            <!-- next link does not work when reading doc in scilab -->
            <!-- <member><link linkend="section_efa4cbf5c15e166f34901f827390e756">Input/Output functions</link></member> -->
        </simplelist>
    </refsection>
</refentry>

