fix the case issue
[scilab.git] / scilab / modules / fileio / help / en_US / fscanf.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" scilab:needs-examples="no" xml:id="fscanf">
15     <refnamediv>
16         <refname>fscanf</refname>
17         <refpurpose>
18             converts formatted input read on a file. <emphasis role="bold">This function is obsolete</emphasis>.
19         </refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Calling Sequence</title>
23         <synopsis>[v_1, ..., v_n] = fscanf(file, format)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>format</term>
30                 <listitem>
31                     <para>
32                         a character string: specifies the format conversion.
33                     </para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>file</term>
38                 <listitem>
39                     <para>
40                         a character string giving the file name or an integer giving a logical unit returned by <function>mopen</function>.
41                     </para>
42                 </listitem>
43             </varlistentry>
44         </variablelist>
45     </refsection>
46     <refsection>
47         <title>Description</title>
48         <para>
49             <warning>
50                 This function is obsolete and will be removed in Scilab 5.5.0, use preferably the <link linkend="mfscanf">mfscanf</link>
51                 function which is more efficient and is more compatible with the C
52                 <function>fscanf</function> procedure.
53             </warning>
54         </para>
55         <para>
56             The <function>fscanf</function> function reads character data on the file specified by the
57             <varname>file</varname> argument, interprets it according
58             to a <varname>format</varname>, and returns the converted results.
59         </para>
60         <para>
61             The <varname>format</varname> parameter contains conversion specifications
62             used to interpret the input.
63         </para>
64         <para>
65             The <varname>format</varname> parameter can contain
66             white-space characters (blanks, tabs, newline, or formfeed)
67             that, except in the following two cases, read the input up to the
68             next nonwhite-space character. Unless there is a match in the control
69             string, trailing white space (including a newline character) is not
70             read.
71         </para>
72         <itemizedlist>
73             <listitem>
74                 <para>
75                     Any character except <literal>%</literal> (percent sign), which must match the next character of the input stream.
76                 </para>
77             </listitem>
78             <listitem>
79                 <para>
80                     A conversion specification that directs the conversion of the next input field. See <link linkend="scanf_conversion">scanf_conversion</link> for details.
81                 </para>
82             </listitem>
83         </itemizedlist>
84     </refsection>
85     <refsection>
86         <title>History</title>
87         <revhistory>
88             <revision>
89                 <revnumber>5.4.1</revnumber>
90                 <revremark>Function tagged as obsolete. Will be removed in 5.5.0.</revremark>
91             </revision>
92         </revhistory>
93     </refsection>
94
95     <refsection role="see also">
96         <title>See Also</title>
97         <simplelist type="inline">
98             <member>
99                 <link linkend="mprintf">mprintf</link>
100             </member>
101             <member>
102                 <link linkend="read">read</link>
103             </member>
104             <member>
105                 <link linkend="scanf">scanf</link>
106             </member>
107             <member>
108                 <link linkend="msscanf">msscanf</link>
109             </member>
110             <member>
111                 <link linkend="mfscanf">mfscanf</link>
112             </member>
113             <member>
114                 <link linkend="scanf_conversion">scanf_conversion</link>
115             </member>
116         </simplelist>
117     </refsection>
118 </refentry>