File: api_pointer.h

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (63 lines) | stat: -rw-r--r-- 1,743 bytes parent folder | download
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
/*
 * 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-en.txt
 */

#ifndef __POINTER_API__
#define __POINTER_API__

#ifdef __cplusplus
extern "C" {
#endif


/**
 * Get pointer variable
 * @param[in] _piAddress variable address
 * @param[out] _pvPtr return pointer
 * @return if the operation successed (0) or not ( !0 )
 */
SciErr getPointer(void* _pvCtx, int* _piAddress, void** _pvPtr);

/**
 * Alloc pointer variable
 * @param[in] _iVar variable number
 * @param[out] _pvPtr return pointer on pointer
 * @return if the operation successed (0) or not ( !0 )
 */
SciErr allocPointer(void* _pvCtx, int _iVar, void** _pvPtr);

/**
 * Create pointer variable
 * @param[in] _iVar variable number
 * @param[in] _pvPtr pointer on pointer
 * @return if the operation successed (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 on pointer
 * @return if the operation successed (0) or not ( !0 )
 */
SciErr createNamedPointer(void* _pvCtx, char* _pstName, void* _pvPtr);

/**
 * Read pointer named variable
 * @param[in] _pstName variable name
 * @param[in] _pvPtr pointer on pointer
 * @return if the operation successed (0) or not ( !0 )
 */
SciErr readNamedPointer(void* _pvCtx, char* _pstName, void** _pvPtr);

#ifdef __cplusplus
}
#endif
#endif /* __POINTER_API__ */