SetNameOfPropertyW

Sets or updates the name of the property, it returns 0 on success.

Error return codes:
    0 successful
    1 argument property is incorrect (not a proper handle to an active property)
    2 argument name is incorrect (nullptr or zero length name)
    3 the name of property is locked
    4 name is already used by another class
    5 name is already used by a property
    6 name is already used by an instance
    7 undefined error

Syntax

C++ 32 bit

C++ 64 bit

C# 32 bit

C# 64 bit

//
//   Strong typing definition
//
int64_t                     SetNameOfPropertyW(
                                    RdfProperty             rdfProperty,
                                    const wchar_t           * name
                                );

static  inline  int64_t SetNameOfPropertyW(
                                RdfProperty             rdfProperty,
                                wchar_t                 * name
                            )
{
    return  SetNameOfPropertyW(
                    rdfProperty,
                    (const wchar_t*) name
                );
}


//
//   Weak typing definition
//
int64_t __declspec(dllexport) __stdcall SetNameOfPropertyW(
                                                int64_t                 rdfProperty,
                                                const wchar_t           * name
                                            );

static  inline  int64_t SetNameOfPropertyW(
                                int64_t                 rdfProperty,
                                wchar_t                 * name
                            )
{
    return  SetNameOfPropertyW(
                    rdfProperty,
                    (const wchar_t*) name
                );
}

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: 32 bit / 4 byte (reference)
This attribute represents the name of the property; either a datatype property or a relation (given as wchar_t array/Unicode). The name is given by the host and the attribute is not changed.

Example (based on pure API calls)

Here you can find code snippets that show how the API call SetNameOfPropertyW can be used.

#include    "./include/engine.h"
#include    <cmath>

int64_t model = CreateModel();

if (model) {
    //
    //  Classes
    //
    int64_t classCollection = GetClassByNameW(model, L"Collection"),
            classCube = GetClassByNameW(model, L"Cube");

    //
    //  Object Properties (relations)
    //
    int64_t propertyAbcd = CreatePropertyW(model, OBJECTPROPERTY_TYPE, L"abcd"),
            propertyObjects = GetPropertyByNameW(model, L"objects");

    //
    //  Datatype Properties (attributes)
    //
    int64_t propertyLength = GetPropertyByNameW(model, L"length"),
            propertyEfgh = CreatePropertyW(model, DATATYPEPROPERTY_TYPE_DOUBLE, L"efgh");

    //
    //  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.);

    wchar_t * propertyNameI = nullptr;
    GetNameOfPropertyW(propertyAbcd, &propertyNameI);

    wchar_t * propertyNameII = nullptr;
    GetNameOfPropertyW(propertyEfgh, &propertyNameII);

    SetNameOfPropertyW(propertyAbcd, L"InverseRelationControledByThirdParty");

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

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

    wchar_t * propertyNameIII = nullptr;
    GetNameOfPropertyW(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
    //
    SaveModelW(model, L"c:\\created\\myFile.bin");
    CloseModel(model);
}