Update of the documentation
[scilab.git] / scilab / modules / external_objects_java / help / en_US / jautoUnwrap.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 *
4 * JIMS ( http://forge.scilab.org/index.php/p/JIMS/ ) - This file is a part of JIMS
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-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="jautoUnwrap">
16     <refnamediv>
17         <refname>jautoUnwrap</refname>
18         <refpurpose>Unwrap automatically returned values</refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>
23             autoUnwrap = jautoUnwrap()
24             jautoUnwrap(autoUnwrap)
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Parameters</title>
29         <variablelist>
30             <varlistentry>
31                 <term>autoUnwrap</term>
32                 <listitem>
33                     <para>A boolean</para>
34                 </listitem>
35             </varlistentry>
36         </variablelist>
37     </refsection>
38     <refsection>
39         <title>Description</title>
40         <para>
41             If autoUnwrap is true, all the values returned by a method invocation are unwrapped if it is possible.
42         </para>
43         <para>
44           This strongly simplifies the usage of the Java / Scilab conversions.
45         </para>
46         <para>
47             By default, autoUnwrap is true.
48         </para>
49     </refsection>
50     <refsection>
51         <title>Examples</title>
52         <programlisting role="example"><![CDATA[
53                jautoUnwrap(%f);
54                jautoUnwrap()
55                jautoUnwrap(%t);
56       ]]></programlisting>
57     </refsection>
58     <refsection role="see also">
59         <title>See Also</title>
60         <simplelist type="inline">
61             <member>
62                 <link linkend="jinvoke">jinvoke</link>
63             </member>
64         </simplelist>
65     </refsection>
66 </refentry>