GPL + CeCILL Header change
[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  * === LICENSE_END ===
16 *
17 *
18 -->
19 <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">
20     <refnamediv>
21         <refname>junwraprem</refname>
22         <refpurpose>Convert a Java object into a Scilab native type and remove it from the Java side</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Calling Sequence</title>
26         <synopsis>
27             [var_1, var_2, ...] = junwraprem(obj_1 [, obj_2 [, ...]])
28         </synopsis>
29     </refsynopsisdiv>
30     <refsection>
31         <title>Parameters</title>
32         <variablelist>
33             <varlistentry>
34                 <term>obj_i</term>
35                 <listitem>
36                     <para>A mlist typed _JObj</para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>var_i</term>
41                 <listitem>
42                     <para>Scilab variable</para>
43                 </listitem>
44             </varlistentry>
45         </variablelist>
46     </refsection>
47     <refsection>
48         <title>Description</title>
49         <para>
50             Convert a native Java object in a Scilab's one and remove it from Java.
51         </para>
52     </refsection>
53     <refsection>
54         <title>Examples</title>
55         <programlisting role="example"><![CDATA[
56                jautoUnwrap(%f);
57                jimport java.lang.String;
58
59                s = String.new("Hello JIMS !!");
60                s1 = s.toUpperCase();
61                s2 = s.toLowerCase();
62                [S1 S2] = junwraprem(s1, s2)
63
64                jremove s
65                jautoUnwrap(%t);
66       ]]></programlisting>
67     </refsection>
68     <refsection role="see also">
69         <title>See Also</title>
70         <simplelist type="inline">
71             <member>
72                 <link linkend="junwrap">junwrap</link>
73             </member>
74             <member>
75                 <link linkend="jwrap">jwrap</link>
76             </member>
77         </simplelist>
78     </refsection>
79     <refsection>
80         <title>History</title>
81         <revhistory>
82             <revision>
83                 <revnumber>5.5.0</revnumber>
84                 <revremark>
85                     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.
86                 </revremark>
87             </revision>
88         </revhistory>
89     </refsection>
90 </refentry>
91