scilab/modules/call_scilab/help/en_US/fromjava.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="fromjava">
   6     <refnamediv>
   7         <refname>fromjava</refname>
   8         <refpurpose>Checks if current Scilab is called from javasci</refpurpose>
   9     </refnamediv>
  10     <refsynopsisdiv>
  11         <title>Syntax</title>
  12         <synopsis>r = fromjava()</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> if Scilab is called from javasci or <literal>%f</literal> if not.
  29         </para>
  30     </refsection>
  31     <refsection>
  32         <title>Example</title>
  33         <programlisting role="example"><![CDATA[
  34 fromjava();
  35  ]]></programlisting>
  36     </refsection>
  37     <refsection role="see also">
  38         <title>See also</title>
  39         <simplelist type="inline">
  40             <member>
  41                 <link linkend="call_scilab">Call_Scilab</link>
  42             </member>
  43             <member>
  44                 <link linkend="fromc">fromc</link>
  45             </member>
  46             <member>
  47                 <link linkend="istssession">istssession</link>
  48             </member>
  49             <member>
  50                 <link linkend="getscilabmode">getscilabmode</link>
  51             </member>
  52         </simplelist>
  53     </refsection>
  54 </refentry>