Files
php-doc-ru/reference/filesystem/functions/fgets.xml
2021-01-28 20:58:51 +03:00

136 lines
4.3 KiB
XML
Raw 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: 359f21684be3993e948f8f7c994c125971665535 Maintainer: shein Status: ready -->
<!-- Reviewed: yes -->
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fgets">
<refnamediv>
<refname>fgets</refname>
<refpurpose>Читает строку из файла</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>fgets</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Читает строку из файлового указателя.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<listitem>
&fs.validfp.all;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
Чтение заканчивается при достижении <parameter>length</parameter> - 1 байт,
либо если встретилась новая строка (которая включается в возвращаемый результат)
или конец файла (в зависимости от того, что наступит раньше).
Если длина не указана, чтение из потока будет продолжаться до тех пор,
пока не достигнет конца строки.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает строку размером в <parameter>length</parameter> - 1 байт, прочитанную
из дескриптора файла, на который указывает параметр <parameter>handle</parameter>.
Если данных для чтения больше нет, то возвращает &false;.
</para>
<para>
В случае возникновения ошибки возвращает &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Построчное чтение файла</title>
<programlisting role="php">
<![CDATA[
<?php
$handle = @fopen("/tmp/inputfile.txt", "r");
if ($handle) {
while (($buffer = fgets($handle, 4096)) !== false) {
echo $buffer;
}
if (!feof($handle)) {
echo "Ошибка: fgets() неожиданно потерпел неудачу\n";
}
fclose($handle);
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.line-endings;
<note>
<para>
Программисты, привыкшие к семантике 'C' функции <function>fgets</function>,
должны принимать во внимание разницу в том, каким образом возвращается
признак достижения конца файла (<literal>EOF</literal>).
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fgetss</function></member>
<member><function>fread</function></member>
<member><function>fgetc</function></member>
<member><function>stream_get_line</function></member>
<member><function>fopen</function></member>
<member><function>popen</function></member>
<member><function>fsockopen</function></member>
<member><function>stream_set_timeout</function></member>
</simplelist>
</para>
</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
-->