Files
doc-fr/reference/stream/functions/stream-get-line.xml
Sergey Panteleev eb40861209 Partially sync docs with English (#138)
Co-authored-by: George Peter Banyard <girgias@php.net>
2021-12-20 11:58:38 +00:00

112 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c3067ab0a7f55632c87da73368fd3c739e110a57 Maintainer: dams Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.stream-get-line" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_get_line</refname>
<refpurpose>Lit une ligne dans un flux</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>
<function>stream_get_line</function> lit une ligne dans la ressource
<parameter>handle</parameter>.
</para>
<para>
La lecture se termine quand <parameter>length</parameter> octets
ont été lus, quand la chaîne non-vide spécifiée par
<parameter>ending</parameter> a été rencontrée (mais
<emphasis>ne sera pas</emphasis> inclue dans la valeur retournée),
ou si <acronym>EOF</acronym> survient : n'importe lequel des trois
qui survient en premier.
</para>
<para>
Cette fonction est presque identique à <function>fgets</function> hormis
le fait qu'elle permet d'utiliser un délimiteur de ligne différent des
caractères standards de <literal>\n</literal>, <literal>\r</literal> et
<literal>\r\n</literal>, et <emphasis>ne retourne pas</emphasis> le délimiteur
lui-même.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
Une &resource; valide de fichier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
Le nombre maximum d'octets à lire depuis le gestionnaire.
Les valeurs négatives ne sont pas supportées.
Zéro (<literal>0</literal>) signifie la taille de chunk de socket par défaut,
i.e. <literal>8192</literal> octets.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ending</parameter></term>
<listitem>
<para>
Un délimiteur de chaîne optionnel.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>stream_get_line</function> lit une ligne de taille maximale
<parameter>length</parameter> dans le flux <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
-->