doc-fr/reference/filesystem/functions/fgets.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.26 $ -->
<!-- EN-Revision: 1.19 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 sur laquelle se trouve le pointeur du fichier</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>fgets</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
  </methodsynopsis>
  <para>
   Récupère la ligne courante sur laquelle se trouve le pointeur du fichier.
  </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>
       Lit jusqu'à la taille <parameter>length</parameter> - 1 octet
       depuis le pointeur de fichier <parameter>handle</parameter>,
       ou bien la fin du fichier, ou une nouvelle ligne (qui inclut
       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>
      <note>
       <para>
        Jusqu'en PHP 4.3.0, le fait d'omettre ce paramètre fait que
        la fonction lira 1024 octets de la ligne.
        Si la majorité des lignes du fichier dépassent les 8 ko,
        il est plus efficace pour votre script de spécifier ce paramètre.
       </para>
      </note>
     </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>handle</parameter>.
  </para>
  <para>
   Si une erreur survient, la fonction retourne &false;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.3.0</entry>
       <entry>
        <function>fgets</function> est compatible avec les données binaires.
       </entry>
      </row>
      <row>
       <entry>4.2.0</entry>
       <entry>
        Le paramètre <parameter>length</parameter> devient optionnel.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Lecture d'un fichier ligne par ligne</title>
    <programlisting role="php">
<![CDATA[
<?php
$handle = @fopen("/tmp/inputfile.txt", "r");
if ($handle) {
    while (!feof($handle)) {
        $buffer = fgets($handle, 4096);
        echo $buffer;
    }
    fclose($handle);
}
?>
]]>
    </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:"../../../../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
-->