License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / api_scilab / includes / returnProperty.h
1 /*
2  * Scilab (http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2006 - INRIA - Jean-Baptiste SILVY
4  *
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  *
7  * This file is hereby licensed under the terms of the GNU GPL v2.0,
8  * pursuant to article 5.3.4 of the CeCILL v.2.1.
9  * This file was originally licensed under the terms of the CeCILL v2.1,
10  * and continues to be available under such terms.
11  * For more information, see the COPYING file which you should have received
12  * along with this program.
13  *
14  */
15 /*------------------------------------------------------------------------*/
16 /* file: returnProperty.h                                                 */
17 /* desc : a set of functions used to return values in Scilab              */
18 /*------------------------------------------------------------------------*/
19
20 #ifndef _RETURN_PROPERTY_H_
21 #define _RETURN_PROPERTY_H_
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 #include "dynlib_api_scilab.h"
28
29
30     /**
31      * create an empty matrix in the scilab stack in order to see it in the console.
32      * @return 0 if the function was executed correctly, -1 if an error occurred.
33      */
34     void* sciReturnEmptyMatrix(void);
35
36     /**
37      * copy the string value in the scilab stack in order to see it the console.
38      * @return 0 if the function was executed correctly, -1 if an error occurred.
39      */
40     void* sciReturnString(const char * value ) ;
41
42     /**
43      * copy a char value into a scilab string in order to see it the console.
44      * @return 0 if the function was executed correctly, -1 if an error occurred.
45      */
46     void* sciReturnChar(char value ) ;
47
48     /**
49      * copy a single double in the scilab stack in order to see it the console.
50      * @return 0 if the function was executed correctly, -1 if an error occurred.
51      */
52     void* sciReturnDouble(double value ) ;
53
54     /**
55      * copy a single int in the scilab stack in order to see it the console.
56      * @return 0 if the function was executed correctly, -1 if an error occurred.
57      */
58     void* sciReturnInt(int value ) ;
59
60     /**
61      * copy a double array into a row vector in the scilab stack in order to see it the console.
62      * @return 0 if the function was executed correctly, -1 if an error occurred.
63      */
64     void* sciReturnRowVector(const double values[], int nbValues ) ;
65
66     /**
67     * copy a int array into a row vector (of double) in the scilab stack
68     * in order to see it the console.
69     * @return 0 if the function was executed correctly, -1 if an error occurred.
70     */
71     void* sciReturnRowVectorFromInt(const int values[], int nbValues ) ;
72
73     /**
74      * copy an int array into an int row vector in the scilab stack
75      * in order to see it the console.
76      * @return 0 if the function was executed correctly, -1 if an error occurred.
77      */
78     void* sciReturnRowIntVector(const int values[], int nbValues ) ;
79
80     /**
81      * copy a char * array into an string row vector in the scilab stack
82      * in order to see it the console.
83      * @return 0 if the function was executed correctly, -1 if an error occurred.
84      */
85     void* sciReturnRowStringVector(char * values[], int nbValues ) ;
86
87     /**
88      * copy a handle in the scilab stack in order to see it the console.
89      * @return 0 if the function was executed correctly, -1 if an error occurred.
90      */
91     void* sciReturnHandle(long handle ) ;
92
93     /**
94      * copy an handle array into a row vector in the scilab stack in order to see it the console.
95      * @return 0 if the function was executed correctly, -1 if an error occurred.
96      */
97     void* sciReturnRowHandleVector(const long handles[], int nbValues ) ;
98
99     /**
100     * copy an handle array into a col vector in the scilab stack in order to see it the console.
101     * @return 0 if the function was executed correctly, -1 if an error occurred.
102     */
103     void* sciReturnColHandleVector(const long handles[], int nbValues ) ;
104
105     /**
106      * copy a matrix stored has a double array
107      * into a Scilab matrix in the stack in order to see it the console.
108      * @return 0 if the function was executed correctly, -1 if an error occurred.
109      */
110     void* sciReturnMatrix(double values[], int nbRow, int nbCol ) ;
111
112     /**
113      * copy a matrix stored has a char * array
114      * into a Scilab string matrix in the stack in order to see it the console.
115      * @return 0 if the function was executed correctly, -1 if an error occurred.
116      */
117     void* sciReturnStringMatrix(char * values[], int nbRow, int nbCol ) ;
118
119     /**
120      * return user data in the scilab console.
121      * @return 0 if the function was executed correctly, -1 if an error occurred.
122      */
123     void* sciReturnUserData(const int * userData, int userDataSize ) ;
124
125     /**
126      * copy a matrix stored has a double hypermatrix
127      * into a Scilab matrix in the stack in order to see it the console.
128      * @return 0 if the function was executed correctly, -1 if an error occurred.
129      */
130     void* sciReturnHypermatOfDouble(int dims[], int ndims, double values[]);
131
132     /**
133      * copy a matrix stored has a int8 hypermatrix
134      * into a Scilab matrix in the stack in order to see it the console.
135      * @return 0 if the function was executed correctly, -1 if an error occurred.
136      */
137     void* sciReturnHypermatOfInteger8(int dims[], int ndims, char values[]);
138
139     /**
140      * copy a matrix stored has a uint8 hypermatrix
141      * into a Scilab matrix in the stack in order to see it the console.
142      * @return 0 if the function was executed correctly, -1 if an error occurred.
143      */
144     void* sciReturnHypermatOfUnsignedInteger8(int dims[], int ndims, unsigned char values[]);
145
146     /**
147      * copy a matrix stored has a int8 array
148      * into a Scilab matrix in the stack in order to see it the console.
149      * @return 0 if the function was executed correctly, -1 if an error occurred.
150      */
151     void* sciReturnMatrixOfInteger8(char values[], int nbRow, int nbCol);
152
153     /**
154      * copy a matrix stored has a uint8 array
155      * into a Scilab matrix in the stack in order to see it the console.
156      * @return 0 if the function was executed correctly, -1 if an error occurred.
157      */
158     void* sciReturnMatrixOfUnsignedInteger8(unsigned char values[], int nbRow, int nbCol);
159
160     /**
161      * copy a matrix stored has a int16 array
162      * into a Scilab matrix in the stack in order to see it the console.
163      * @return 0 if the function was executed correctly, -1 if an error occurred.
164      */
165     void* sciReturnMatrixOfInteger16(short values[], int nbRow, int nbCol);
166
167     /**
168      * copy a matrix stored has a uint16 array
169      * into a Scilab matrix in the stack in order to see it the console.
170      * @return 0 if the function was executed correctly, -1 if an error occurred.
171      */
172     void* sciReturnMatrixOfUnsignedInteger16(unsigned short values[], int nbRow, int nbCol);
173
174     /**
175      * copy a matrix stored has a int32 array
176      * into a Scilab matrix in the stack in order to see it the console.
177      * @return 0 if the function was executed correctly, -1 if an error occurred.
178      */
179     void* sciReturnMatrixOfInteger32(int values[], int nbRow, int nbCol);
180
181     /**
182      * copy a matrix stored has a uint32 array
183      * into a Scilab matrix in the stack in order to see it the console.
184      * @return 0 if the function was executed correctly, -1 if an error occurred.
185      */
186     void* sciReturnMatrixOfUnsignedInteger32(unsigned int values[], int nbRow, int nbCol);
187 #ifdef __cplusplus
188 }
189 #endif
190 #endif /* _RETURN_PROPERTY_H_ */