(PHP 4 >= 4.0.1, PHP 5, PHP 7)
sscanf — Überträgt einen String in ein angegebenes Format
Die Funktion sscanf() ist das Eingabegegenstück zu
printf(). sscanf() liest den String
str und interpretiert ihn entsprechend dem
übergegebenen format-Parameter , der in der
Dokumentation zu sprintf() näher beschrieben ist.
Beliebige Whitespaces im Formatstring entsprechen beliebigen Whitespaces im Inputstring. Das heißt, dass auch ein Tabulator \t im Formatstring einem einzelnen Leerzeichen des Inputstrings entsprechen kann.
strDer zu parsende Eingabestring.
format
Das interpretierte Format für str, wie es in der
Dokumentation zu sprintf() beschrieben ist;
folgende Unterschiede bestehen:
F, g, G und
b sind nicht unterstützt.
D steht für eine Dezimal Ziffer.
i steht für Ganzzahlen mit Angabe der Basis.
n steht für die Anzahl der bisher prozessierten Zeichen.
s beendet das Lesen am ersten Whitespace-Zeichen.
...Optionale als Referenz übergebene Variablen, die die geparsten Werte enthalten.
Werden nur 2 Parameter an die Funktion übergeben, werden die analysierten Werte als Array zurückgegeben. Andernfalls, wenn optionale Parameter übergeben wurden, gibt die Funktion die Anzahl der ermittelten Werte zurück. Die optionalen Parameter müssen als Referenz übergeben werden.
Werden mehr Teilzeichenketten in format erwartet
als in str verfügbar sind, wird -1
zurückgegeben.
Beispiel #1 sscanf()-Beispiel
<?php
// Ermittlung der Serien-Nr.
list($serial) = sscanf("SN/2350001", "SN/%d");
// und des Herstellungsdatums
$mandate = "Januar 01 2000";
list($monat, $tag, $jahr) = sscanf($mandate, "%s %d %d");
echo "Das Teil $serial wurde hergestellt am: "
. "$jahr-" . substr($monat, 0, 3) . "-$tag\n";
?>
Werden optionale Parameter übergeben, gibt die Funktion die Anzahl der ermittelten Werte zurück.
Beispiel #2 sscanf() - Verwendung optionaler Parameter
<?php
// Auslesen der Autoren-Info und Erzeugung eines DocBook-Eintrages
$auth = "24\tLewis Carroll";
$n = sscanf($auth, "%d\t%s %s", $id, $first, $last);
echo "<author id='$id'>
<firstname>$first</firstname>
<surname>$last</surname>
</author>\n";
?>