php8.5
Home/ Manual/ filesystem / functions/ fscanf

fscanf

PHP function Edit on GitHub ✎

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

Parses input from a file according to a format

Description

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

The function fscanf() is similar to sscanf(), but it takes its input from a file associated with stream and interprets the input according to the specified format.

Any whitespace in the format string matches any whitespace in the input stream. This means that even a tab (\t) in the format string can match a single space character in the input stream.

Each call to fscanf() reads one line from the file.

Parameters

stream

Pointer

vars

The optional assigned values.

Return Values

If only two parameters were passed to this function, the values parsed will be returned as an array. Otherwise, if optional parameters are passed, the function will return the number of assigned values. The optional parameters must be passed by reference.

If there are more substrings expected in the format than there are available within string, null will be returned. On other errors, false will be returned.

When optional parameters are used and the end of the input read from stream is reached before any value has been parsed, -1 is returned.

Examples

fscanf() Example

php
<?php
$handle = fopen("users.txt", "r");
while ($userinfo = fscanf($handle, "%s\t%s\t%s\n")) {
    list ($name, $profession, $countrycode) = $userinfo;
    //... do something with the values
}
fclose($handle);
?>

Contents of users.txt

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

See Also

Source: reference/filesystem/functions/fscanf.xml · from the official PHP manual (php/doc-en)