fscanf
(PHP 4 >= 4.0.1, PHP 5, PHP 7)
fscanf — Parses input from a file according to a format
Description
The function fscanf() is similar to
sscanf(), but it takes its input from a file
associated with handle and interprets the
input according to the specified format, which is
described in the documentation for sprintf().
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
-
handle -
A file system pointer resource that is typically created using fopen().
-
format -
The format string is composed of zero or more directives: ordinary characters (excluding %) that are copied directly to the result and conversion specifications, each of which results in fetching its own parameter.
A conversion specification follows this prototype: %[flags][width][.precision]specifier.
Flags Flag Description - Left-justify within the given field width; Right justification is the default + Prefix positive numbers with a plus sign +; Default only negative are prefixed with a negative sign. (space) Pads the result with spaces. This is the default. 0 Only left-pads numbers with zeros. With s specifiers this can also right-pad with zeros. '(char) Pads the result with the character (char). Width
An integer that says how many characters (minimum) this conversion should result in.
Precision
A period . followed by an integer who's meaning depends on the specifier:
- For e, E, f and F specifiers: this is the number of digits to be printed after the decimal point (by default, this is 6).
- For g and G specifiers: this is the maximum number of significant digits to be printed.
- For s specifier: it acts as a cutoff point, setting a maximum character limit to the string.
Note: If the period is specified without an explicit value for precision, 0 is assumed.
Note: Attempting to use a position specifier greater than
PHP_INT_MAXwill generate warnings.Specifiers Specifier Description % A literal percent character. No argument is required. b The argument is treated as an integer and presented as a binary number. c The argument is treated as an integer and presented as the character with that ASCII. d The argument is treated as an integer and presented as a (signed) decimal number. e The argument is treated as scientific notation (e.g. 1.2e+2). The precision specifier stands for the number of digits after the decimal point since PHP 5.2.1. In earlier versions, it was taken as number of significant digits (one less). E Like the e specifier but uses uppercase letter (e.g. 1.2E+2). f The argument is treated as a float and presented as a floating-point number (locale aware). F The argument is treated as a float and presented as a floating-point number (non-locale aware). Available as of PHP 5.0.3. g General format.
Let P equal the precision if nonzero, 6 if the precision is omitted, or 1 if the precision is zero. Then, if a conversion with style E would have an exponent of X:
If P > X ≥ −4, the conversion is with style f and precision P − (X + 1). Otherwise, the conversion is with style e and precision P − 1.
G Like the g specifier but uses E and F. o The argument is treated as an integer and presented as an octal number. s The argument is treated and presented as a string. u The argument is treated as an integer and presented as an unsigned decimal number. x The argument is treated as an integer and presented as a hexadecimal number (with lowercase letters). X The argument is treated as an integer and presented as a hexadecimal number (with uppercase letters). WarningThe c type specifier ignores padding and width
WarningAttempting to use a combination of the string and width specifiers with character sets that require more than one byte per character may result in unexpected results
Variables will be co-erced to a suitable type for the specifier:
Type Handling Type Specifiers string s integer d, u, c, o, x, X, b double g, G, e, E, f, F -
... -
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.
Examples
Example #1 fscanf() Example
<?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);
?>
Example #2 Contents of users.txt
javier argonaut pe hiroshi sculptor jp robert slacker us luigi florist it
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.fscanf.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
