faf8cec7d5cc125cf3f85f7ae404abc6f4bae42b
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_utilities_functions / importXcosDiagram.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) 2010 - DIGITEO - ClĂ©ment DAVID
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:ns3="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="importXcosDiagram">
17     <refnamediv>
18         <refname>importXcosDiagram</refname>
19         <refpurpose>Import a Xcos diagram on Scilab</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>[result]=importXcosDiagram(filename)</synopsis>
24     </refsynopsisdiv>
25     <refsection id="Module_importXcosDiagram">
26         <title>Module</title>
27         <itemizedlist>
28             <listitem>
29                 <para>
30                     <link linkend="xcos">xcos</link>
31                 </para>
32             </listitem>
33         </itemizedlist>
34     </refsection>
35     <refsection id="Description_importXcosDiagram">
36         <title>Description</title>
37         <para>Import a Xcos file into Scilab.</para>
38     </refsection>
39     <refsection>
40         <title>Examples</title>
41         <programlisting role="example">
42             filename=SCI+"/modules/xcos/demos/demo_Datatype.zcos";
43             [result]=importXcosDiagram(filename)
44         </programlisting>
45     </refsection>
46     <refsection id="Parameters_importXcosDiagram">
47         <title>Arguments</title>
48         <itemizedlist>
49             <listitem>
50                 <para>
51                     <emphasis role="bold">result:</emphasis> The status of the
52                     operation.
53                 </para>
54             </listitem>
55             <listitem>
56                 <para>
57                     <emphasis role="bold">filename:</emphasis> The Xcos file to
58                     load.
59                 </para>
60             </listitem>
61         </itemizedlist>
62     </refsection>
63 </refentry>