Update of the documentation
[scilab.git] / scilab / modules / external_objects_java / help / en_US / jgetclassname.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="jgetclassname">
16     <refnamediv>
17         <refname>jgetclassname</refname>
18         <refpurpose>Return the class name of the given object</refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>
23             name = jgetclassname(obj)
24         </synopsis>
25     </refsynopsisdiv>
26     <refsection>
27         <title>Parameters</title>
28         <variablelist>
29             <varlistentry>
30                 <term>obj</term>
31                 <listitem>
32                     <para>A mlist typed _JObj</para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>name</term>
37                 <listitem>
38                     <para>A Scilab string</para>
39                 </listitem>
40             </varlistentry>
41         </variablelist>
42     </refsection>
43     <refsection>
44         <title>Description</title>
45         <para>
46             Get the class name.
47         </para>
48     </refsection>
49     <refsection>
50         <title>Examples</title>
51         <programlisting role="example"><![CDATA[
52                s = jwrap("Hello World !");
53                jgetclassname(s)
54
55                jremove s;
56       ]]></programlisting>
57     </refsection>
58 </refentry>