Documentation: `See also` is used instead of `See Also`.
[scilab.git] / scilab / modules / external_objects_java / help / en_US / junwraprem.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 *
4 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5 * Copyright (C) 2010 - 2011 - Calixte DENIZET <calixte@contrib.scilab.org>
6 *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15 *
16 *
17 -->
18 <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="junwraprem">
19     <refnamediv>
20         <refname>junwraprem</refname>
21         <refpurpose>Convert a Java object into a Scilab native type and remove it from the Java side</refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>
26             [var_1, var_2, ...] = junwraprem(obj_1 [, obj_2 [, ...]])
27         </synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>Parameters</title>
31         <variablelist>
32             <varlistentry>
33                 <term>obj_i</term>
34                 <listitem>
35                     <para>A mlist typed _JObj</para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>var_i</term>
40                 <listitem>
41                     <para>Scilab variable</para>
42                 </listitem>
43             </varlistentry>
44         </variablelist>
45     </refsection>
46     <refsection>
47         <title>Description</title>
48         <para>
49             Convert a native Java object in a Scilab's one and remove it from Java.
50         </para>
51     </refsection>
52     <refsection>
53         <title>Examples</title>
54         <programlisting role="example"><![CDATA[
55                jautoUnwrap(%f);
56                jimport java.lang.String;
57
58                s = String.new("Hello JIMS !!");
59                s1 = s.toUpperCase();
60                s2 = s.toLowerCase();
61                [S1 S2] = junwraprem(s1, s2)
62
63                jremove s
64                jautoUnwrap(%t);
65       ]]></programlisting>
66     </refsection>
67     <refsection role="see also">
68         <title>See also</title>
69         <simplelist type="inline">
70             <member>
71                 <link linkend="junwrap">junwrap</link>
72             </member>
73             <member>
74                 <link linkend="jwrap">jwrap</link>
75             </member>
76         </simplelist>
77     </refsection>
78     <refsection>
79         <title>History</title>
80         <revhistory>
81             <revision>
82                 <revnumber>5.5.0</revnumber>
83                 <revremark>
84                     Function introduced. Based on the 'JIMS' module. The main difference in the behavior compared to the JIMS module is that <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
85                 </revremark>
86             </revision>
87         </revhistory>
88     </refsection>
89 </refentry>
90