Fix CeCill license number
[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 * This file must be used under the terms of the CeCILL.
8 * This source file is licensed as described in the file COPYING, which
9 * you should have received as part of this distribution.  The terms
10 * are also available at
11 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
12 *
13 *
14 -->
15 <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">
16     <refnamediv>
17         <refname>junwraprem</refname>
18         <refpurpose>Convert a Java object into a Scilab native type and remove it from the Java side</refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>
23             [var_1, var_2, ...] = junwraprem(obj_1 [, obj_2 [, ...]])
24         </synopsis>
25     </refsynopsisdiv>
26     <refsection>
27         <title>Parameters</title>
28         <variablelist>
29             <varlistentry>
30                 <term>obj_i</term>
31                 <listitem>
32                     <para>A mlist typed _JObj</para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>var_i</term>
37                 <listitem>
38                     <para>Scilab variable</para>
39                 </listitem>
40             </varlistentry>
41         </variablelist>
42     </refsection>
43     <refsection>
44         <title>Description</title>
45         <para>
46             Convert a native Java object in a Scilab's one and remove it from Java.
47         </para>
48     </refsection>
49     <refsection>
50         <title>Examples</title>
51         <programlisting role="example"><![CDATA[
52                jautoUnwrap(%f);
53                jimport java.lang.String;
54
55                s = String.new("Hello JIMS !!");
56                s1 = s.toUpperCase();
57                s2 = s.toLowerCase();
58                [S1 S2] = junwraprem(s1, s2)
59
60                jremove s
61                jautoUnwrap(%t);
62       ]]></programlisting>
63     </refsection>
64     <refsection role="see also">
65         <title>See Also</title>
66         <simplelist type="inline">
67             <member>
68                 <link linkend="junwrap">junwrap</link>
69             </member>
70             <member>
71                 <link linkend="jwrap">jwrap</link>
72             </member>
73         </simplelist>
74     </refsection>
75     <refsection>
76         <title>History</title>
77         <revhistory>
78             <revision>
79                 <revnumber>5.5.0</revnumber>
80                 <revremark>
81                     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.
82                 </revremark>
83             </revision>
84         </revhistory>
85     </refsection>
86 </refentry>
87