Use simply 'Syntax' for function synopsis in the help...
[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  *
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: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">
17     <refnamediv>
18         <refname>getScalarDouble</refname>
19         <refpurpose>
20             Get scalar double variable.
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>int getScalarDouble(void* _pvCtx, int* _piAddress, double* _pdblReal)</synopsis>
26         <synopsis>int getNamedScalarDouble(void* _pvCtx, const char* _pstName, double* _pdblReal)</synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>_pvCtx</term>
33                 <listitem>
34                     <para>
35                         Scilab environment pointer, pass in "pvApiCtx" provided by api_scilab.h.
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>_piAddress</term>
41                 <listitem>
42                     <para>
43                         Address of the Scilab variable.
44                     </para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>_pstName</term>
49                 <listitem>
50                     <para>
51                         Name of the variable for "named" functions.
52                     </para>
53                 </listitem>
54             </varlistentry>
55             <varlistentry>
56                 <term>_pdblReal</term>
57                 <listitem>
58                     <para>
59                         Double value.
60                     </para>
61                 </listitem>
62             </varlistentry>
63         </variablelist>
64     </refsection>
65     <refsection>
66         <title>Return value</title>
67         <para>if successful 0, otherwise print error(s) message(s) in the Scilab console and returns first error number.</para>
68     </refsection>
69 </refentry>