1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
/*
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2009 - DIGITEO - Antoine ELIAS
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*/
#ifndef __POINTER_API__
#define __POINTER_API__
#if !defined(__INTERNAL_API_SCILAB__)
#error Do not include api_pointer.h. Include api_scilab.h instead.
#endif
#ifdef __cplusplus
extern "C" {
#endif
/**
* Get pointer variable
* @param[in] _piAddress variable address
* @param[out] _pvPtr return pointer
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr getPointer(void* _pvCtx, int* _piAddress, void** _pvPtr);
/**
* Allocate a pointer variable
* @param[in] _iVar variable number
* @param[out] _pvPtr return pointer
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr allocPointer(void* _pvCtx, int _iVar, void** _pvPtr);
/**
* Create pointer variable
* @param[in] _iVar variable number
* @param[in] _pvPtr pointer
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr createPointer(void* _pvCtx, int _iVar, void* _pvPtr);
/**
* Create named pointer variable
* @param[in] _pstName variable name
* @param[in] _pvPtr pointer
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr createNamedPointer(void* _pvCtx, const char* _pstName, void* _pvPtr);
/**
* Read pointer named variable
* @param[in] _pstName variable name
* @param[out] _pvPtr return pointer
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr readNamedPointer(void* _pvCtx, const char* _pstName, void** _pvPtr);
/* shortcut functions */
/**
* Check if the variable is of pointer type
* @param[in] _piAddress variable address
* @return 1 for true and 0 for false
*/
int isPointerType(void* _pvCtx, int* _piAddress);
/**
* check if the named variable type of pointer type
* @param[in] _pstName variable name
* @return 1 for true and 0 for false
*/
int isNamedPointerType(void* _pvCtx, const char* _pstName);
#ifdef __cplusplus
}
#endif
#endif /* __POINTER_API__ */
|
