License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / api_scilab / help / en_US / legacy / integer / B_getScalarInteger.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="getScalarInteger8" xml:lang="en">
17     <refnamediv>
18         <refname>getScalarInteger8</refname>
19         <refpurpose>
20             Get scalar integer variable.
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Calling Sequence</title>
25         <synopsis>int getScalarInteger8(void* _pvCtx, int* _piAddress, char* _pcData)</synopsis>
26         <synopsis>int getNamedScalarInteger8(void* _pvCtx, const char* _pstName, char* _pcData)</synopsis>
27         <synopsis>int getScalarInteger16(void* _pvCtx, int* _piAddress, short* _psData)</synopsis>
28         <synopsis>int getNamedScalarInteger16(void* _pvCtx, const char* _pstName, short* _psData)</synopsis>
29         <synopsis>int getScalarInteger32(void* _pvCtx, int* _piAddress, int* _piData)</synopsis>
30         <synopsis>int getNamedScalarInteger32(void* _pvCtx, const char* _pstName, int* _piData)</synopsis>
31         <synopsis>int getScalarUnsignedInteger8(void* _pvCtx, int* _piAddress, unsigned char* _pucData)</synopsis>
32         <synopsis>int getNamedScalarUnsignedInteger8(void* _pvCtx, const char* _pstName, unsigned char* _pucData)</synopsis>
33         <synopsis>int getScalarUnsignedInteger16(void* _pvCtx, int* _piAddress, unsigned short* _pusData)</synopsis>
34         <synopsis>int getNamedScalarUnsignedInteger16(void* _pvCtx, const char* _pstName, unsigned short* _pusData)</synopsis>
35         <synopsis>int getScalarUnsignedInteger32(void* _pvCtx, int* _piAddress, unsigned int* _puiData)</synopsis>
36         <synopsis>int getNamedScalarUnsignedInteger32(void* _pvCtx, const char* _pstName, unsigned int* _puiData)</synopsis>
37     </refsynopsisdiv>
38     <refsection>
39         <title>Arguments</title>
40         <variablelist>
41             <varlistentry>
42                 <term>_pvCtx</term>
43                 <listitem>
44                     <para>
45                         Scilab environment pointer, pass in "pvApiCtx" provided by api_scilab.h.
46                     </para>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>_piAddress</term>
51                 <listitem>
52                     <para>
53                         Address of the Scilab variable.
54                     </para>
55                 </listitem>
56             </varlistentry>
57             <varlistentry>
58                 <term>_pstName</term>
59                 <listitem>
60                     <para>
61                         Name of the variable for "named" functions.
62                     </para>
63                 </listitem>
64             </varlistentry>
65             <varlistentry>
66                 <term>_cData</term>
67                 <listitem>
68                     <para>
69                         Integer 8 bits value.
70                     </para>
71                 </listitem>
72             </varlistentry>
73             <varlistentry>
74                 <term>_sData</term>
75                 <listitem>
76                     <para>
77                         Integer 16 bits value.
78                     </para>
79                 </listitem>
80             </varlistentry>
81             <varlistentry>
82                 <term>_iData</term>
83                 <listitem>
84                     <para>
85                         Integer 32 bits value.
86                     </para>
87                 </listitem>
88             </varlistentry>
89             <varlistentry>
90                 <term>_ucData</term>
91                 <listitem>
92                     <para>
93                         Unsigned integer 8 bits value.
94                     </para>
95                 </listitem>
96             </varlistentry>
97             <varlistentry>
98                 <term>_usData</term>
99                 <listitem>
100                     <para>
101                         Unsigned integer 16 bits value.
102                     </para>
103                 </listitem>
104             </varlistentry>
105             <varlistentry>
106                 <term>_uiData</term>
107                 <listitem>
108                     <para>
109                         Unsigned integer 32 bits value.
110                     </para>
111                 </listitem>
112             </varlistentry>
113         </variablelist>
114     </refsection>
115     <refsection>
116         <title>Return value</title>
117         <para>if successful 0, otherwise print error(s) message(s) in the Scilab console and returns first error number.</para>
118     </refsection>
119 </refentry>