License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / api_scilab / help / en_US / I_pointer.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) 2015  - Scilab Enterprises - 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="api_pointer" xml:lang="en">
17     <refnamediv>
18         <refname>API pointer functions</refname>
19         <para>This page lists all the functions to manipulate Scilab native objects containing pointers</para>
20         <para></para>
21     </refnamediv>
22     <refsynopsisdiv>
23         <refsection id="api_pointer_scilab_createPointer">
24             <literal>
25                 <link linkend="api_types_scilabVar">
26                     <command>scilabVar</command>
27                 </link>
28                 <varname>scilab_createPointer</varname>(
29                 <link linkend="api_types_scilabEnv">
30                     <command>scilabEnv</command>
31                 </link>
32                 env, void* val)
33             </literal>
34             <para>
35                 Create a pointer variable from <varname>val</varname>.
36             </para>
37         </refsection>
38         <refsection id="api_pointer_scilab_getPointer">
39             <literal>
40                 <link linkend="api_types_scilabStatus">
41                     <command>scilabStatus</command>
42                 </link>
43                 <varname>scilab_getPointer</varname>(
44                 <link linkend="api_types_scilabEnv">
45                     <command>scilabEnv</command>
46                 </link>
47                 env, 
48                 <link linkend="api_types_scilabVar">
49                     <command>scilabVar</command>
50                 </link>
51                 var, void const** val)
52             </literal>
53             <para>
54                 Get pointer value <varname>val</varname> from pointer variable.
55             </para>
56         </refsection>
57         <refsection id="api_pointer_scilab_setPointer">
58             <literal>
59                 <link linkend="api_types_scilabStatus">
60                     <command>scilabStatus</command>
61                 </link>
62                 <varname>scilab_setPointer</varname>(
63                 <link linkend="api_types_scilabEnv">
64                     <command>scilabEnv</command>
65                 </link>
66                 env, 
67                 <link linkend="api_types_scilabVar">
68                     <command>scilabVar</command>
69                 </link>
70                 var, const void* val)
71             </literal>
72             <para>
73                 Set value <varname>val</varname> of a pointer variable <literal>var</literal>.
74             </para>
75         </refsection>
76     </refsynopsisdiv>
77 </refentry>