1c395f8b4ed4f9b3967cd48bece0fa857845ec13
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_utilities_functions / scicos_log.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="scicos_log">
3     <refnamediv>
4         <refname>scicos_log</refname>
5         <refpurpose>Logger utility for scicos</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>
10             log=scicos_log(log);
11             log=scicos_log(log, msg);
12         </synopsis>
13     </refsynopsisdiv>
14     <refsection>
15         <title>Arguments</title>
16         <variablelist>
17             <varlistentry>
18                 <term>log</term>
19                 <listitem>
20                     <para>String, logger value. The supported values are : "FATAL", "ERROR", "WARNING", "INFO", "DEBUG", "TRACE"</para>
21                 </listitem>
22             </varlistentry>
23             <varlistentry>
24                 <term>msg</term>
25                 <listitem>
26                     <para>
27                         String, the message to log.
28                     </para>
29                 </listitem>
30             </varlistentry>
31         </variablelist>
32     </refsection>
33     <refsection>
34         <title>Description</title>
35         <para>
36             This function implements a logger for <literal>scicos</literal> operation. This function lets the user choose the right level of information to print while loading a model, compiling and simulating it.
37         </para>
38     </refsection>
39     <refsection>
40         <title>Examples</title>
41         <programlisting role="example"><![CDATA[
42 scicos_log("TRACE"),
43 scicos_log("TRACE", "this is a trace message");
44  ]]></programlisting>
45     </refsection>
46     <refsection role="see also">
47         <title>See also</title>
48         <simplelist type="inline">
49             <member>
50                 <link linkend="scicos_debug">scicos_debug</link>
51             </member>
52         </simplelist>
53     </refsection>
54 </refentry>
55