License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / atoms / help / en_US / atomsGetLoaded.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="atomsGetLoaded" xml:lang="en">
17     <refnamediv>
18         <refname>atomsGetLoaded</refname>
19         <refpurpose>Get the list of loaded external modules</refpurpose>
20     </refnamediv>
21     <!-- ===================================================================== -->
22     <!-- Calling Sequence -->
23     <!-- ===================================================================== -->
24     <refsynopsisdiv>
25         <title>Calling Sequence</title>
26         <synopsis>
27             loaded = atomsGetLoaded()
28         </synopsis>
29     </refsynopsisdiv>
30     <!-- ===================================================================== -->
31     <!-- Parameters -->
32     <!-- ===================================================================== -->
33     <refsection>
34         <title>Arguments</title>
35         <variablelist>
36             <varlistentry>
37                 <term>loaded</term>
38                 <listitem>
39                     <para>mx5 String matrix :</para>
40                     <itemizedlist>
41                         <listitem>
42                             <para>
43                                 <literal>1st column</literal> : External module's technical name
44                             </para>
45                         </listitem>
46                         <listitem>
47                             <para>
48                                 <literal>2nd column</literal> : External module's version
49                             </para>
50                         </listitem>
51                         <listitem>
52                             <para>
53                                 <literal>3rd column</literal> : allusers/user, this parameter tell if
54                                 the external module has been installed for all users or only for the
55                                 current user.
56                             </para>
57                         </listitem>
58                         <listitem>
59                             <para>
60                                 <literal>4th column</literal> : External module's installation path
61                             </para>
62                         </listitem>
63                         <listitem>
64                             <para>
65                                 <literal>5th column</literal> : I/A, this parameter tell if
66                                 the external module has been automatically or intentionally installed.
67                             </para>
68                         </listitem>
69                     </itemizedlist>
70                 </listitem>
71             </varlistentry>
72         </variablelist>
73     </refsection>
74     <!-- ===================================================================== -->
75     <!-- Description -->
76     <!-- ===================================================================== -->
77     <refsection>
78         <title>Description</title>
79         <para>
80             <literal>atomsGetLoaded</literal> returns the list of loaded external modules
81         </para>
82     </refsection>
83     <!-- ===================================================================== -->
84     <!-- Examples -->
85     <!-- ===================================================================== -->
86     <refsection>
87         <title>Examples</title>
88         <programlisting role="example"><![CDATA[
89 atomsSetConfig("Verbose","True");
90 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
91 atomsInstall("toolbox_5");
92 atomsLoad("toolbox_5");
93
94 atomsGetLoaded("toolbox_5");
95
96 atomsRemove("toolbox_5");
97  ]]></programlisting>
98     </refsection>
99     <!-- ===================================================================== -->
100     <!-- See also -->
101     <!-- ===================================================================== -->
102     <refsection role="see also">
103         <title>See Also</title>
104         <simplelist type="inline">
105             <member>
106                 <link linkend="atomsLoad">atomsLoad</link>
107             </member>
108             <member>
109                 <link linkend="atomsIsLoaded">atomsIsLoaded</link>
110             </member>
111         </simplelist>
112     </refsection>
113     <!-- ===================================================================== -->
114     <!-- Authors -->
115     <!-- ===================================================================== -->
116 </refentry>