fgets.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 32e694be42ba6e75a8c78483c17a75725937d247 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fgets">
 <refnamediv>
  <refname>fgets</refname>
  <refpurpose>Récupère la ligne courante à partir de l'emplacement du pointeur sur fichier</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>stream</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Récupère la ligne courante à partir de l'emplacement du pointeur sur fichier.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      &fs.validfp.all;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Lit jusqu'à la taille <parameter>length</parameter> - 1 octet
       depuis le pointeur de fichier <parameter>stream</parameter>,
       ou bien la fin du fichier, ou une nouvelle ligne (qui est inclue
       dans la valeur retournée), ou encore un EOF (celui qui arrive en
       premier). Si aucune longueur n'est fournie, la fonction lira
       le flux jusqu'à la fin de la ligne.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une &string; contenant les <parameter>length</parameter> premiers
   caractères, moins 1 octet depuis le pointeur de fichier
   <parameter>stream</parameter>. &false; est retourné s'il n'y a plus de
   données à lire.
  </para>
  <para>
   Si une erreur survient, la fonction retourne &false;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Lecture d'un fichier ligne par ligne</title>
    <programlisting role="php">
<![CDATA[
<?php

$fp = @fopen("/tmp/inputfile.txt", "r");

if ($fp) {
    while (($buffer = fgets($fp, 4096)) !== false) {
        echo $buffer, PHP_EOL;
    }
    if (!feof($fp)) {
        echo "Erreur: fgets() a échoué\n";
    }

    fclose($fp);
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.line-endings;
  <note>
   <para>
    Les programmeurs habitués à la programmation 'C' noteront que
    <function>fgets</function> ne se comporte pas comme son équivalent C
    lors de la rencontre de la fin du fichier.
   </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
-->