fseek.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: cmb Status: ready -->
<refentry xml:id="function.fseek" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fseek</refname>
  <refpurpose>Positioniert den Dateizeiger</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>fseek</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>whence</parameter><initializer><constant>SEEK_SET</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Setzt den Dateizeiger einer mit <parameter>stream</parameter> angegebenen
   Datei auf eine neue Position. Diese neue Position, angegeben in Bytes
   vom Beginn der Datei an, wird definiert durch Hinzufügen von
   <parameter>offset</parameter> zu der Position spezifiziert durch
   <parameter>whence</parameter>.
  </para>
  <para>
   Im Allgemeinen ist es erlaubt hinter das Ende der Datei (EOF) zu
   positionieren; wenn dann Daten geschrieben werden, ergeben Leseoperation in
   einer unbeschriebenen Region zwischen dem EOF und der gesetzten Position
   Bytes mit dem Wert 0. Allerdings unterstützen bestimmte Streams dieses
   Verhalten möglicherweise nicht, besonders wenn sie einen unterliegenden
   Speicher fester Größe haben.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      &fs.file.pointer;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Der Offset.
      </para>
      <para>
       Um zu einer Position vor EOF zu gelangen, übergeben Sie in
       <parameter>offset</parameter> einen negativen Wert und setzen Sie
       <parameter>whence</parameter> auf <constant>SEEK_END</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>whence</parameter></term>
     <listitem>
      <para>
       <parameter>whence</parameter> Werte sind:
       <simplelist>
        <member><constant>SEEK_SET</constant> - Setzt Position gleich <parameter>offset</parameter> Bytes</member>
        <member><constant>SEEK_CUR</constant> - Setzt Position auf die aktuelle Stelle plus <parameter>offset</parameter>.</member>
        <member><constant>SEEK_END</constant> - Setzt die Position ans Ende der Datei plus <parameter>offset</parameter>.</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Bei Erfolg wird 0 zurückgegeben, andernfalls -1.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>fseek</function> Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php

$fp = fopen('somefile.txt', 'r');

// lies einige Daten
$data = fgets($fp, 4096);

// gehe zurück an den Anfang der Datei
// das selbe wie rewind($fp);
fseek($fp, 0);

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

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Wenn Sie die Datei im Anfügemodus (<literal>a</literal> oder
    <literal>a+</literal>) geöffnet haben, werden jegliche Daten, die sie in die
    Datei schreiben, immer angehängt, unabhängig vom Dateizeiger, und das
    Ergebnis des Aufrufs von <function>seek</function> ist undefiniert.
   </para>
  </note>
  <note>
   <para>
    Nicht alle Streams unterstützen Positionierung. Für jene, die Positionierung
    nicht unterstützen, kann Vorwärtspositionierung durch Lesen und Verwerfen
    von Daten erreicht werden; andere Formen der Positionierung schlagen fehl.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ftell</function></member>
    <member><function>rewind</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
-->