GPL + CeCILL Header change
[scilab.git] / scilab / modules / api_scilab / help / en_US / legacy / double / B_getScalarDouble.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) 2009  - DIGITEO - Antoine ELIAS
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  * === LICENSE_END ===
15  *
16  -->
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="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="getScalarDouble" xml:lang="en">
18     <refnamediv>
19         <refname>getScalarDouble</refname>
20         <refpurpose>
21             Get scalar double variable.
22         </refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Calling Sequence</title>
26         <synopsis>int getScalarDouble(void* _pvCtx, int* _piAddress, double* _pdblReal)</synopsis>
27         <synopsis>int getNamedScalarDouble(void* _pvCtx, const char* _pstName, double* _pdblReal)</synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>Arguments</title>
31         <variablelist>
32             <varlistentry>
33                 <term>_pvCtx</term>
34                 <listitem>
35                     <para>
36                         Scilab environment pointer, pass in "pvApiCtx" provided by api_scilab.h.
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>_piAddress</term>
42                 <listitem>
43                     <para>
44                         Address of the Scilab variable.
45                     </para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>_pstName</term>
50                 <listitem>
51                     <para>
52                         Name of the variable for "named" functions.
53                     </para>
54                 </listitem>
55             </varlistentry>
56             <varlistentry>
57                 <term>_pdblReal</term>
58                 <listitem>
59                     <para>
60                         Double value.
61                     </para>
62                 </listitem>
63             </varlistentry>
64         </variablelist>
65     </refsection>
66     <refsection>
67         <title>Return value</title>
68         <para>if successful 0, otherwise print error(s) message(s) in the Scilab console and returns first error number.</para>
69     </refsection>
70 </refentry>