summaryrefslogtreecommitdiff
path: root/modules/atoms/help/en_US/atomsGetLoaded.xml
blob: 6dece4ec64c54e288f273adff60620709a6ef2f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 *
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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">
    <refnamediv>
        <refname>atomsGetLoaded</refname>
        <refpurpose>Get the list of loaded external modules</refpurpose>
    </refnamediv>
    <!-- ===================================================================== -->
    <!-- Calling Sequence -->
    <!-- ===================================================================== -->
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>
            loaded = atomsGetLoaded()
        </synopsis>
    </refsynopsisdiv>
    <!-- ===================================================================== -->
    <!-- Parameters -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>loaded</term>
                <listitem>
                    <para>mx5 String matrix :</para>
                    <itemizedlist>
                        <listitem>
                            <para>
                                <literal>1st column</literal> : External module's technical name
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>2nd column</literal> : External module's version
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>3rd column</literal> : allusers/user, this parameter tell if
                                the external module has been installed for all users or only for the
                                current user.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>4th column</literal> : External module's installation path
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>5th column</literal> : I/A, this parameter tell if
                                the external module has been automatically or intentionaly installed.
                            </para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Description -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Description</title>
        <para>
            <literal>atomsGetLoaded</literal> returns the list of loaded external modules
        </para>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Examples -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
atomsSetConfig("Verbose","True");
atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
atomsInstall("toolbox_5");
atomsLoad("toolbox_5");

atomsGetLoaded("toolbox_5");

atomsRemove("toolbox_5");
 ]]></programlisting>
    </refsection>
    <!-- ===================================================================== -->
    <!-- See also -->
    <!-- ===================================================================== -->
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="atomsLoad">atomsLoad</link>
            </member>
            <member>
                <link linkend="atomsIsLoaded">atomsIsLoaded</link>
            </member>
        </simplelist>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Authors -->
    <!-- ===================================================================== -->
</refentry>