SetNameOfPropertyEx

Sets/updates the name of the property, if no error it returns 0.
In case property does not exist it returns 1, when name cannot be updated 2.

Syntax

C++ 32 bit

C++ 64 bit

C# 32 bit

C# 64 bit

//   Visual Studio for Windows
public:
__int64 __declspec(dllexport) __stdcall SetNameOfPropertyEx(
            __int64             model,
            __int64             rdfProperty,
            const char          * name
        );

//   Linux, OS-X and non-Visual Studio Windows solutions
public:
int64_t SetNameOfPropertyEx(
            int64_t             model,
            int64_t             rdfProperty,
            const char          * name
        );

Property model

Size: 64 bit / 8 byte (value)
The handle to the model. The model handle is static during its existance. Several models can be opened simultaniously within one session. Different models are always independent, threads are allowed to be running on different models simultaniously.

Property rdfProperty

Size: 64 bit / 8 byte (value)
This attribute represents a handle to the property, this can be either a datatype property (attribute), an object property (relation) or non-defined property. The handle will be static during the life-time of the model, when the model (or part of it) is saved and opened again, the handle will most probably be different.

Property name

Size: 64 bit / 8 byte (reference)
This attribute represents the name of the property; either a datatype property or a relation (given as char array / ASCII). The name is given by the host and the attribute is not changed.

Example

Here you can find code snippits that show how the API call SetNameOfPropertyEx can be used.

#include 

int64_t model = CreateModel();

if (model) {
    //
    //  The following setting makes sure all properties handled are in an ordered list
    //  In certain cases where several models are open or in case of conversion
    //  between formats this can be handy and / or time efficient.
    //
    int64_t propertyCnt = 0;
    OrderedHandles(model, nullptr, &propertyCnt, nullptr, 2, 2);

    //
    //  Classes
    //
    int64_t classCollection = GetClassByName(model, "Collection"),
            classCube = GetClassByName(model, "Cube");

    //
    //  Object Properties (relations)
    //
    int64_t propertyAbcd = CreateProperty(model, OBJECTPROPERTY_TYPE, "abcd"),
            propertyObjects = GetPropertyByName(model, "objects");
    assert(propertyAbcd == propertyCnt + 1);
    assert(propertyObjects > 0 && propertyObjects <= propertyCnt);

    //
    //  Datatype Properties (attributes)
    //
    int64_t propertyLength = GetPropertyByName(model, "length"),
            propertyEfgh = CreateProperty(model, DATATYPEPROPERTY_TYPE_DOUBLE, "efgh");
    assert(propertyLength > 0 && propertyLength <= propertyCnt);
    assert(propertyEfgh == propertyCnt + 2);

    //
    //  Instances (creating)
    //
    int64_t instanceCollection = CreateInstance(classCollection, nullptr),
            instanceCube = CreateInstance(classCube, nullptr);

    double  length = 2.,
            efgh = 1.7;

    SetDatatypeProperty(instanceCube, propertyLength, &length, 1);
    SetDatatypeProperty(instanceCollection, propertyEfgh, &efgh, 1);

    assert(GetVolume(instanceCollection, 0, 0) == 0.);

    char    * propertyNameI = nullptr;
    GetNameOfPropertyEx(model, propertyAbcd, &propertyNameI);

    char    * propertyNameII = nullptr;
    GetNameOfPropertyEx(model, propertyEfgh, &propertyNameII);

    SetNameOfPropertyEx(model, propertyAbcd, "InverseRelationControledByThirdParty");

    SetObjectProperty(instanceCube, propertyAbcd, &instanceCollection, 1);
    SetObjectProperty(instanceCollection, propertyObjects, &instanceCube, 1);

    assert(GetVolume(instanceCollection, 0, 0) == 8.);

    char    * propertyNameIII = nullptr;
    GetNameOfPropertyEx(model, propertyAbcd, &propertyNameIII);

    //
    //  The retrieved property names have the following values 
    //      propertyNameI   :  'abcd'
    //      propertyNameII  :  'efgh'
    //      propertyNameIII :  'InverseRelationControledByThirdParty'
    //

    //
    //  The resulting model can be viewed in 3D-Editor.exe
    //
    SaveModel(model, "c:\\created\\myFile.bin");
    CloseModel(model);
}