8371079f8b20ab9d3b56157fc4c22a65588f5818
[scilab.git] / scilab / modules / graphics / src / cpp / get_tag_property.cpp
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2011 - DIGITEO - Vincent COUVERT
4  * Copyright (C) 2017 - Scilab Enterprises - ClĂ©ment DAVID
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
17 /*------------------------------------------------------------------------*/
18 /* file: get_tag_property.cpp                                               */
19 /* desc : function to retrieve in Scilab the tag field of                 */
20 /*        a handle                                                        */
21 /*------------------------------------------------------------------------*/
22
23 extern "C"
24 {
25 #include "sci_types.h"
26 #include "getHandleProperty.h"
27 #include "returnProperty.h"
28 #include "Scierror.h"
29 #include "localization.h"
30
31 #include "getGraphicObjectProperty.h"
32 #include "graphicObjectProperties.h"
33 }
34
35 /*------------------------------------------------------------------------*/
36 void* get_tag_property(void* _pvCtx, int iObjUID)
37 {
38     char* tag = NULL;
39     void* status = NULL;
40
41         // the tag pointer is allocated using new[]
42     getGraphicObjectProperty(iObjUID,  __GO_TAG__, jni_string, (void**) &tag);
43
44     if (tag == NULL)
45     {
46         Scierror(999, _("'%s' property does not exist for this handle.\n"), "Tag");
47         return nullptr;
48     }
49     else
50     {
51         status = sciReturnString(tag);
52         delete[] tag;
53         return status;
54     }
55 }
56 /*------------------------------------------------------------------------*/