fscanf function removed. (obsolete)
[scilab.git] / scilab / modules / fileio / help / en_US / scanf.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  * ...
6  *
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at
11  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
12  *
13  -->
14 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="scanf">
15     <refnamediv>
16         <refname>scanf</refname>
17         <refpurpose>converts formatted input on standard input</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Calling Sequence</title>
21         <synopsis>[v_1, ..., v_n] = scanf(format);</synopsis>
22     </refsynopsisdiv>
23     <refsection>
24         <title>Arguments</title>
25         <variablelist>
26             <varlistentry>
27                 <term>format</term>
28                 <listitem>
29                     <para>a character string: specifies the format conversion.</para>
30                 </listitem>
31             </varlistentry>
32             <varlistentry>
33                 <term>v_1, ..., v_n</term>
34                 <listitem>
35                     <para>converted results.</para>
36                 </listitem>
37             </varlistentry>
38         </variablelist>
39     </refsection>
40     <refsection>
41         <title>Description</title>
42         <para>
43             The <function>scanf</function> function gets character data on standard input (<code>%io(1)</code>), interprets it according
44             to a <varname>format</varname>, and returns the converted results <varname>v_1</varname>, ..., <varname>v_n</varname>.
45         </para>
46         <para>
47             The <varname>format</varname> parameter contains conversion specifications
48             used to interpret the input.
49         </para>
50         <para>
51             The <varname>format</varname> parameter can contain
52             white-space characters (blanks, tabs, newline, or formfeed)
53             that, except in the following two cases, read the input up to the
54             next nonwhite-space character. Unless there is a match in the control
55             string, trailing white-space (including a newline character) is not
56             read.
57         </para>
58         <itemizedlist>
59             <listitem>
60                 <para>
61                     Any character except <literal>%</literal> (percent sign), which must match the next character of the input stream.
62                 </para>
63             </listitem>
64             <listitem>
65                 <para>
66                     A conversion specification that directs the conversion of the next input field. See <link linkend="scanf_conversion">scanf_conversion</link> for details.
67                 </para>
68             </listitem>
69         </itemizedlist>
70     </refsection>
71     <refsection role="see also">
72         <title>See Also</title>
73         <simplelist type="inline">
74             <member>
75                 <link linkend="read">read</link>
76             </member>
77             <member>
78                 <link linkend="mfscanf">mfscanf</link>
79             </member>
80             <member>
81                 <link linkend="scanf_conversion">scanf_conversion</link>
82             </member>
83         </simplelist>
84     </refsection>
85 </refentry>