fscanf.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4225e50bc391ddba99e367c231463da0dc04357d Maintainer: nikic Status: ready -->
<refentry xml:id="function.fscanf" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fscanf</refname>
  <refpurpose>Interpretiert den Input einer Datei entsprechend einem
   angegebenen Format</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>int</type><type>false</type><type>null</type></type><methodname>fscanf</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam><type>string</type><parameter>format</parameter></methodparam>
   <methodparam rep="repeat"><type>mixed</type><parameter role="reference">vars</parameter></methodparam>
  </methodsynopsis>
  <para>
   Die Funktion <function>fscanf</function> ist ähnlich zu
   <function>sscanf</function>, wobei sie ihren Input aus
   der mit <parameter>stream</parameter> angegebenen Datei liest, und
   entsprechend dem angegebenen <parameter>format</parameter>
   interpretiert.
  </para>
  <para>
   Beliebige Whitespace-Zeichen (&zb; Leerzeichen, Tabulator etc.)
   im Format String gelten mit beliebigen Whitespace-Zeichen des
   Input-Streams als übereinstimmend. Das heißt, dass auch ein
   Tabulator (<literal>\t</literal>) im Formatstring mit einem einzigen
   Leerzeichen im Input-Stream als übereinstimmend gelten kann.
  </para>
  <para>
   Jeder <function>fscanf</function>-Aufruf liest eine Zeile aus der Datei aus.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      &fs.file.pointer;
     </listitem>
    </varlistentry>
    &strings.scanf.parameter.format;
    <varlistentry>
     <term><parameter>vars</parameter></term>
     <listitem>
      <para>
       Die optional zugewiesenen Werte.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Wenn nur zwei Parameter an die Funktion übergeben wurden, werden die geparseten
   Werte in einem Array zurückgegeben. Andernfalls gibt die Funktion die Anzahl
   der zugewiesenen Werte zurück. Die optionalen Parameter müssen per Referenz
   übergeben werden.
  </para>
  <para>
   Wenn im <parameter>format</parameter> mehr Teilstrings erwartet werden,
   als in <parameter>string</parameter> verfügbar sind, wird &null; zurückgegeben.
   Bei anderen Fehlern wird &false; zurückgegeben.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>fscanf</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
$handle = fopen("users.txt", "r");
while ($userinfo = fscanf($handle, "%s\t%s\t%s\n")) {
    list ($name, $profession, $countrycode) = $userinfo;
    // Tue etwas mit den Werten ...
}
fclose($handle);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Inhalt der Datei users.txt</title>
    <programlisting role="txt">
<![CDATA[
javier  argonaut        pe
hiroshi sculptor        jp
robert  slacker us
luigi   florist it
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fread</function></member>
    <member><function>fgets</function></member>
    <member><function>fgetss</function></member>
    <member><function>sscanf</function></member>
    <member><function>printf</function></member>
    <member><function>sprintf</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
-->