stream-seek.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 70528fcff5b182ed42bcdee3acf0bf304896a518 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="streamwrapper.stream-seek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>streamWrapper::stream_seek</refname>
  <refpurpose>Place le pointeur de flux à une position</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_seek</methodname>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam><type>int</type><parameter>whence</parameter> <initializer>SEEK_SET</initializer></methodparam>
  </methodsynopsis>
  <para>
   Cette méthode est appelée en réponse à <function>fseek</function>.
  </para>
  <para>
   La position de lecture/écriture doit être modifiée pour refléter
   la nouvelle position <parameter>offset</parameter> et
   <parameter>whence</parameter>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       La position à rechercher dans le flux.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>whence</parameter></term>
     <listitem>
      <para>
       Les valeurs possibles sont : 
       <simplelist>
        <member><constant>SEEK_SET</constant> : la nouvelle position vaut <parameter>offset</parameter> octets.</member>
        <member><constant>SEEK_CUR</constant> : la nouvelle position vaut la position courante plus <parameter>offset</parameter>.</member>
        <member><constant>SEEK_END</constant> : la nouvelle position vaut la fin de fichier plus <parameter>offset</parameter>.</member>
       </simplelist>
      </para>
      <note>
       <simpara>
        L'implémentation actuelle ne définie jamais <parameter>whence</parameter> à
        <constant>SEEK_CUR</constant>; en effet ces recherches de position sont
        convertie en interne à des recherches de type <constant>SEEK_SET</constant>.
       </simpara>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne &true; si la position a été mise à jour, 
   &false; sinon.
  </para>
 </refsect1>
 
 <refsect1 role="notes"><!-- {{{ -->
  &reftitle.notes;
  <note>
   <para>
    Si elle n'est pas implémentée, &false; sera utilisée comme
    valeur de retour.
   </para>
  </note>
  <note>
   <para>
    En cas de succès, 
    <methodname>streamWrapper::stream_tell</methodname> est appelée 
    directement après <methodname>streamWrapper::stream_seek</methodname>. 
    Si <methodname>streamWrapper::stream_tell</methodname> échoue, 
    la valeur retournée à la fonction appelante &false;.
   </para>
  </note>
  <note>
   <para>
    Toutes les opérations de déplacement sur un flux ne nécessitent pas
    obligatoirement l'utilisation de cette fonction. Les flux PHP
    ont la lecture en mémoire tampon d'activé par défaut (voir aussi la
    fonction <function>stream_set_read_buffer</function>) ainsi que la
    déplacement dans ce flux, pouvant être effectué en déplaçant le pointeur
    du buffer.
   </para>
  </note>
 </refsect1><!-- }}} -->
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fseek</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
-->