New C API for Scilab gateways (once again ...)
[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  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <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">
14     <refnamediv>
15         <refname>getScalarDouble</refname>
16         <refpurpose>
17             Get scalar double variable.
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>int getScalarDouble(void* _pvCtx, int* _piAddress, double* _pdblReal)</synopsis>
23         <synopsis>int getNamedScalarDouble(void* _pvCtx, const char* _pstName, double* _pdblReal)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>_pvCtx</term>
30                 <listitem>
31                     <para>
32                         Scilab environment pointer, pass in "pvApiCtx" provided by api_scilab.h.
33                     </para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>_piAddress</term>
38                 <listitem>
39                     <para>
40                         Address of the Scilab variable.
41                     </para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>_pstName</term>
46                 <listitem>
47                     <para>
48                         Name of the variable for "named" functions.
49                     </para>
50                 </listitem>
51             </varlistentry>
52             <varlistentry>
53                 <term>_pdblReal</term>
54                 <listitem>
55                     <para>
56                         Double value.
57                     </para>
58                 </listitem>
59             </varlistentry>
60         </variablelist>
61     </refsection>
62     <refsection>
63         <title>Return value</title>
64         <para>if successful 0, otherwise print error(s) message(s) in the Scilab console and returns first error number.</para>
65     </refsection>
66 </refentry>