array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'de', ), 'this' => array ( 0 => 'function.fscanf.php', 1 => 'fscanf', 2 => 'Interpretiert den Input einer Datei entsprechend einem angegebenen Format', ), 'up' => array ( 0 => 'ref.filesystem.php', 1 => 'Dateisystem', ), 'prev' => array ( 0 => 'function.fread.php', 1 => 'fread', ), 'next' => array ( 0 => 'function.fseek.php', 1 => 'fseek', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'de', 'path' => 'reference/filesystem/functions/fscanf.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

fscanf

(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)

fscanf — Interpretiert den Input einer Datei entsprechend einem angegebenen Format

Beschreibung

function fscanf(resource $stream, string $format, mixed &...$vars): array|int|false|null

Die Funktion fscanf() ist ähnlich zu sscanf(), wobei sie ihren Input aus der mit stream angegebenen Datei liest, und entsprechend dem angegebenen format interpretiert.

Beliebige Whitespace-Zeichen (z. B. Leerzeichen, Tabulator etc.) im Format String gelten mit beliebigen Whitespace-Zeichen des Input-Streams als übereinstimmend. Das heißt, dass auch ein Tabulator (\t) im Formatstring mit einem einzigen Leerzeichen im Input-Stream als übereinstimmend gelten kann.

Jeder fscanf()-Aufruf liest eine Zeile aus der Datei aus.

Parameter-Liste

stream

Eine Dateisystemressource (resource), wie sie in der Regel von fopen() zurückgegeben wird.

format

Das interpretierte Format für string, wie es in der Dokumentation zu sprintf() beschrieben ist, mit den folgenden Unterschieden:

  • Die Funktion beachtet die Locale nicht.
  • F, g, G und b werden nicht unterstützt.
  • D steht für eine Dezimalzahl.
  • i steht für eine Ganzzahl mit Angabe der Basis.
  • n steht für die Anzahl der bisher verarbeiteten Zeichen.
  • s beendet das Lesen beim ersten Whitespace-Zeichen.
  • * anstelle von argnum$ unterdrückt die Zuweisung dieser Umwandlungsspezifikation.

vars
Die optional zugewiesenen Werte.

Rückgabewerte

Wenn nur zwei Parameter an die Funktion übergeben wurden, werden die geparseten Werte als array zurückgegeben. Andernfalls gibt die Funktion die Anzahl der zugewiesenen Werte zurück. Die optionalen Parameter müssen per Referenz übergeben werden.

Wenn im format mehr Teilstrings erwartet werden, als in string verfügbar sind, wird null zurückgegeben. Bei anderen Fehlern wird false zurückgegeben.

Wenn optionale Parameter verwendet werden und das Ende des aus stream gelesenen Inputs erreicht wird, bevor ein Wert geparst werden konnte, wird -1 zurückgegeben.

Beispiele

Beispiel #1 fscanf()-Beispiel

<?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);
?>

Beispiel #2 Inhalt der Datei users.txt

javier  argonaut        pe
hiroshi sculptor        jp
robert  slacker us
luigi   florist it

Siehe auch