New C API for Scilab gateways (once again ...)
[scilab.git] / scilab / modules / api_scilab / help / en_US / legacy / integer / C_createScalarInteger.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="createScalarInteger8" xml:lang="en">
14     <refnamediv>
15         <refname>createScalarInteger8</refname>
16         <refpurpose>
17             Create scalar integer variable.
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>int createScalarInteger8(void* _pvCtx, int _iVar, char cData)</synopsis>
23         <synopsis>int createNamedScalarInteger8(void* _pvCtx, const char* _pstName, char _cData)</synopsis>
24         <synopsis>int createScalarInteger16(void* _pvCtx, int _iVar, short sData)</synopsis>
25         <synopsis>int createNamedScalarInteger16(void* _pvCtx, const char* _pstName, short _sData)</synopsis>
26         <synopsis>int createScalarInteger32(void* _pvCtx, int _iVar, int iData)</synopsis>
27         <synopsis>int createNamedScalarInteger32(void* _pvCtx, const char* _pstName, int _iData)</synopsis>
28         <synopsis>int createScalarUnsignedInteger8(void* _pvCtx, int _iVar, unsigned char ucData)</synopsis>
29         <synopsis>int createNamedScalarUnsignedInteger8(void* _pvCtx, const char* _pstName, unsigned char _ucData)</synopsis>
30         <synopsis>int createScalarUnsignedInteger16(void* _pvCtx, int _iVar, unsigned short usData)</synopsis>
31         <synopsis>int createNamedScalarUnsignedInteger16(void* _pvCtx, const char* _pstName, unsigned short _usData)</synopsis>
32         <synopsis>int createScalarUnsignedInteger32(void* _pvCtx, int _iVar, unsigned int uiData)</synopsis>
33         <synopsis>int createNamedScalarUnsignedInteger32(void* _pvCtx, const char* _pstName, unsigned int _uiData)</synopsis>
34     </refsynopsisdiv>
35     <refsection>
36         <title>Arguments</title>
37         <variablelist>
38             <varlistentry>
39                 <term>_pvCtx</term>
40                 <listitem>
41                     <para>
42                         Scilab environment pointer, pass in "pvApiCtx" provided by api_scilab.h.
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>_iVar</term>
48                 <listitem>
49                     <para>
50                         Position in the Scilab memory where you want to put the variable.
51                     </para>
52                 </listitem>
53             </varlistentry>
54             <varlistentry>
55                 <term>_pstName</term>
56                 <listitem>
57                     <para>
58                         Name of the variable for "named" functions.
59                     </para>
60                 </listitem>
61             </varlistentry>
62             <varlistentry>
63                 <term>_cData</term>
64                 <listitem>
65                     <para>
66                         Integer 8 bits value.
67                     </para>
68                 </listitem>
69             </varlistentry>
70             <varlistentry>
71                 <term>_sData</term>
72                 <listitem>
73                     <para>
74                         Integer 16 bits value.
75                     </para>
76                 </listitem>
77             </varlistentry>
78             <varlistentry>
79                 <term>_iData</term>
80                 <listitem>
81                     <para>
82                         Integer 32 bits value.
83                     </para>
84                 </listitem>
85             </varlistentry>
86             <varlistentry>
87                 <term>_ucData</term>
88                 <listitem>
89                     <para>
90                         Unsigned integer 8 bits value.
91                     </para>
92                 </listitem>
93             </varlistentry>
94             <varlistentry>
95                 <term>_usData</term>
96                 <listitem>
97                     <para>
98                         Unsigned integer 16 bits value.
99                     </para>
100                 </listitem>
101             </varlistentry>
102             <varlistentry>
103                 <term>_uiData</term>
104                 <listitem>
105                     <para>
106                         Unsigned integer 32 bits value.
107                     </para>
108                 </listitem>
109             </varlistentry>
110         </variablelist>
111     </refsection>
112     <refsection>
113         <title>Return value</title>
114         <para>if successful 0, otherwise print error(s) message(s) in the Scilab console and returns first error number.</para>
115     </refsection>
116 </refentry>