GetNameOfPropertyW

Returns the name of the property, if the property does not exist it returns nullptr.

Syntax

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

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

static  inline  const wchar_t   * GetNameOfPropertyW(
                                        RdfProperty             rdfProperty
                                    )
{
    return  GetNameOfPropertyW(
                    rdfProperty,
                    (const wchar_t**) nullptr           //    name
                );
}


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

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

static  inline  const wchar_t   * GetNameOfPropertyW(
                                        int64_t                 rdfProperty
                                    )
{
    return  GetNameOfPropertyW(
                    rdfProperty,
                    (const wchar_t**) nullptr           //    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: 64 bit / 8 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 defined in space allocated by the library, this memory will be released as soon as the model is closed, or memory release is forced by CleanMemory.

Example (based on pure API calls)

Here you can find code snippits that show how the API call GetNameOfPropertyW 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);
}