php-doc-en/reference/filesystem/functions/fscanf.xml
Sander Roobol 948efe3655 tab is \t, not \n - 18845
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@91513 c90b9560-bf6c-de11-be94-00142212c4b1
2002-08-11 10:53:41 +00:00

86 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fscanf">
<refnamediv>
<refname>fscanf</refname>
<refpurpose>Parses input from a file according to a format</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>fscanf</methodname>
<methodparam><type>int</type><parameter>handle</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>var1</parameter></methodparam>
</methodsynopsis>
<para>
The function <function>fscanf</function> is similar to
<function>sscanf</function>, but it takes its input from a file
associated with <parameter>handle</parameter> and interprets the
input according to the specified
<parameter>format</parameter>. 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.
</para>
<para>
Any whitespace in the format string matches any whitespace in the input
stream. This means that even a tab <literal>\t</literal> in the format
string can match a single space character in the input stream.
</para>
<para>
<example>
<title><function>fscanf</function> Example</title>
<programlisting role="php">
<![CDATA[
$fp = fopen ("users.txt","r");
while ($userinfo = fscanf ($fp, "%s\t%s\t%s\n")) {
list ($name, $profession, $countrycode) = $userinfo;
//... do something with the values
}
fclose($fp);
]]>
</programlisting>
</example>
<example>
<title>users.txt</title>
<programlisting>
<![CDATA[
javier argonaut pe
hiroshi sculptor jp
robert slacker us
luigi florist it
]]>
</programlisting>
</example>
</para>
<para>
See also <function>fread</function>, <function>fgets</function>,
<function>fgetss</function>, <function>sscanf</function>,
<function>printf</function>, and <function>sprintf</function>.
</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:"../../../../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
-->