725a809a5caf41148473e97dab8f525f40893606
[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" 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="fromc">
3     <refnamediv>
4         <refname>fromc</refname>
5         <refpurpose>Checks if current Scilab is called from an external C program (by StartScilab).</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>r=fromc()</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>r</term>
16                 <listitem>
17                     <para>a boolean</para>
18                 </listitem>
19             </varlistentry>
20         </variablelist>
21     </refsection>
22     <refsection>
23         <title>Description</title>
24         <para>
25             Returns <literal>%t</literal>Checks if current Scilab is called from an external C program or <literal>%f</literal> if not.
26         </para>
27     </refsection>
28
29     <refsection>
30         <title>Example</title>
31         <programlisting role="example"><![CDATA[
32 fromc();
33  ]]></programlisting>
34     </refsection>
35     <refsection role="see also">
36         <title>See also</title>
37         <simplelist type="inline">
38             <member>
39                 <link linkend="call_scilab">Call_Scilab</link>
40             </member>
41             <member>
42                 <link linkend="fromjava">fromjava</link>
43             </member>
44         </simplelist>
45     </refsection>
46 </refentry>