scilab/modules/fileio/help/en_US/sscanf.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) XXXX-2008 - INRIA
   5  *
   6  * This file must be used under the terms of the CeCILL.
   7  * This source file is licensed as described in the file COPYING, which
   8  * you should have received as part of this distribution.  The terms
   9  * are also available at
  10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  11  *
  12  -->
  13 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="sscanf">
  14     <refnamediv>
  15         <refname>sscanf</refname>
  16         <refpurpose>
  17             converts formatted input given by a string (<emphasis role="bold">this function is obsolete)</emphasis>
  18         </refpurpose>
  19     </refnamediv>
  20     <refsynopsisdiv>
  21         <title>Calling Sequence</title>
  22         <synopsis>[v_1, ..., v_n]=sscanf(string, format)</synopsis>
  23     </refsynopsisdiv>
  24     <refsection>
  25         <title>Arguments</title>
  26         <variablelist>
  27             <varlistentry>
  28                 <term>format</term>
  29                 <listitem>
  30                     <para>specifies the format conversion.</para>
  31                 </listitem>
  32             </varlistentry>
  33             <varlistentry>
  34                 <term>string</term>
  35                 <listitem>
  36                     <para>specifies input to be read.</para>
  37                 </listitem>
  38             </varlistentry>
  39             <varlistentry>
  40                 <term>v_1, ..., v_n</term>
  41                 <listitem>
  42                     <para>converted results.</para>
  43                 </listitem>
  44             </varlistentry>
  45         </variablelist>
  46     </refsection>
  47     <refsection>
  48         <title>Description</title>
  49         <para>
  50             <warning>
  51                 This function is obsolete, use preferably the
  52                 <function>msscanf</function> function which is more efficient and
  53                 is more compatible with the C <function>sscanf</function>
  54                 procedure.
  55             </warning>
  56         </para>
  57         <para>
  58             The <function>sscanf</function> function interprets character string
  59             according to a <varname>format</varname>, and returns the converted
  60             results <varname>v_1</varname>, ..., <varname>v_n</varname>.
  61         </para>
  62         <para>
  63             The <varname>format</varname> parameter contains conversion
  64             specifications used to interpret the input.
  65         </para>
  66         <para>
  67             The <varname>format</varname> parameter can contain
  68             white-space characters (blanks, tabs, newline, or formfeed)
  69             that, except in the following two cases, read the input up to the
  70             next nonwhite-space character. Unless there is a match in the control
  71             string, trailing white-space (including a newline character) is not
  72             read.
  73         </para>
  74         <itemizedlist>
  75             <listitem>
  76                 <para>
  77                     Any character except <literal>%</literal> (percent sign), which
  78                     must match the next character of the input stream.
  79                 </para>
  80             </listitem>
  81             <listitem>
  82                 <para>
  83                     A conversion specification that directs the conversion of the
  84                     next input field. See <link linkend="scanf_conversion">scanf_conversion</link> for details.
  85                 </para>
  86             </listitem>
  87         </itemizedlist>
  88     </refsection>
  89     <refsection role="see also">
  90         <title>See Also</title>
  91         <simplelist type="inline">
  92             <member>
  93                 <link linkend="mprintf">mprintf</link>
  94             </member>
  95             <member>
  96                 <link linkend="mfscanf">mfscanf</link>
  97             </member>
  98             <member>
  99                 <link linkend="scanf_conversion">scanf_conversion</link>
 100             </member>
 101         </simplelist>
 102     </refsection>
 103 </refentry>