[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / call_scilab / help / en_US / fromc.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"
3           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
4           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
5           xml:lang="en" xml:id="fromc">
6     <refnamediv>
7         <refname>fromc</refname>
8         <refpurpose>Checks if current Scilab is called from an external C program (by StartScilab).</refpurpose>
9     </refnamediv>
10     <refsynopsisdiv>
11         <title>Syntax</title>
12         <synopsis>r=fromc()</synopsis>
13     </refsynopsisdiv>
14     <refsection>
15         <title>Arguments</title>
16         <variablelist>
17             <varlistentry>
18                 <term>r</term>
19                 <listitem>
20                     <para>a boolean</para>
21                 </listitem>
22             </varlistentry>
23         </variablelist>
24     </refsection>
25     <refsection>
26         <title>Description</title>
27         <para>
28             Returns <literal>%t</literal>Checks if current Scilab is called from an external C program or <literal>%f</literal> if not.
29         </para>
30     </refsection>
31
32     <refsection>
33         <title>Example</title>
34         <programlisting role="example"><![CDATA[
35 fromc();
36  ]]></programlisting>
37     </refsection>
38     <refsection role="see also">
39         <title>See also</title>
40         <simplelist type="inline">
41             <member>
42                 <link linkend="call_scilab">Call_Scilab</link>
43             </member>
44             <member>
45                 <link linkend="fromjava">fromjava</link>
46             </member>
47             <member>
48                 <link linkend="istssession">istssession</link>
49             </member>
50             <member>
51                 <link linkend="getscilabmode">getscilabmode</link>
52             </member>
53         </simplelist>
54     </refsection>
55 </refentry>