Files
php-doc-ru/reference/stream/functions/stream-get-line.xml
2021-12-16 12:33:41 +03:00

106 lines
3.9 KiB
XML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c3067ab0a7f55632c87da73368fd3c739e110a57 Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.stream-get-line" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_get_line</refname>
<refpurpose>Получает строку из потокового ресурса до указанного разделителя</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>stream_get_line</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>ending</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Получает строку из указанного дескриптора.
</para>
<para>
Чтение заканчивается, когда прочитано <parameter>length</parameter> количество байт
и когда найдена непустая строка, указанная в параметре <parameter>ending</parameter> (она
<emphasis>не</emphasis> включается в возвращаемое значение) или достигнут <acronym>EOF</acronym>
(смотря что произойдёт раньше).
</para>
<para>
Функция очень похожа на функцию <function>fgets</function>, кроме того,
что она позволяет использовать разделители строк, отличающиеся от стандартных \n, \r, и
\r\n, и <emphasis>не</emphasis> возвращает сам разделитель.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
Допустимый дескриптор файла.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
Максимальное количество байтов для чтения из дескриптора.
Отрицательные значения не поддерживаются.
Ноль (<literal>0</literal>) означает размер блока сокета по умолчанию,
т.е. <literal>8192</literal> байта.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ending</parameter></term>
<listitem>
<para>
Необязательный разделитель строки.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает строку длиной до <parameter>length</parameter> байт, прочитанную из файла
указанного параметром <parameter>stream</parameter>&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>fread</function></member>
<member><function>fgets</function></member>
<member><function>fgetc</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->