fgets.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 32e694be42ba6e75a8c78483c17a75725937d247 Maintainer: khp Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: ea62fb83196997032641b50fe44420305466195e Reviewer: samesch -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fgets">
 <refnamediv>
  <refname>fgets</refname>
  <refpurpose>Liest die Zeile von der Position des Dateizeigers</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>
   Liest die Zeile von der Position des Dateizeigers.
  </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>
       Der Lesevorgang endet, wenn <parameter>length</parameter> - 1 Bytes
       gelesen wurden, bei einem Zeilenumbruch (der im Rückgabewert enthalten
       ist) oder am Dateiende (EOF) (je nachdem, was zuerst kommt). Wurde
       keine Länge übergeben, wird aus dem Stream gelesen, bis das Zeilenende
       erreicht ist.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt eine Zeichenkette mit einer Länge von bis zu
   <parameter>length</parameter> - 1 Bytes zurück, die aus der Datei gelesen
   wurde, auf die <parameter>stream</parameter> zeigt. Wenn keine Daten mehr
   aus dem Dateizeiger zu lesen sind, wird &false; zurückgegeben.
  </para>
  <para>
   Wenn ein Fehler auftritt, wird &false; zurückgegeben.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Eine Datei Zeile für Zeile lesen</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 "Fehler: fgets() schlug unerwartet fehl\n";
    }

    fclose($fp);
}

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

 <refsect1 role="notes">
  &reftitle.notes;
  &note.line-endings;
  <note>
   <para>
    Wer die C-Semantik von <function>fgets</function> gewohnt ist, sollte den
    Unterschied in der Rückgabe des Dateiende-Zeichens
    (<literal>EOF</literal>) beachten.
   </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
-->