GetNameOfInstanceW

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

Syntax

public const string EngineDLL = @"engine.dll";[DllImport(EngineDLL, EntryPoint = "GetNameOfInstanceW")]
public static extern void GetNameOfInstanceW(Int64 owlInstance, out IntPtr name);

Property owlInstance

Size: 64 bit / 8 byte (value)
The handle to the specific instance in the design tree. The instance handle is static within one open model but is most probably different when the same instance is opened in another model. The instance is always exactly of one unique class.

Property name

Size: 32 bit / 4 byte (reference)
This attribute represents the name of the instance (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

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

using Engine;

static void Main(string[] args)
{
    Int64 model = Engine.x86_64.CreateModel();

    if (model != 0)
    {
        //
        //  Classes
        //
        Int64   classCube = Engine.x86_64.GetClassByNameW(model, System.Text.Encoding.Unicode.GetBytes("Cube"));

        //
        //  Datatype Properties (attributes)
        //
        Int64   propertyLength = Engine.x86_64.GetPropertyByNameW(model, System.Text.Encoding.Unicode.GetBytes("length"));

        //
        //  Instances (creating)
        //
        Int64   myInstanceI = Engine.x86_64.CreateInstanceW(classCube, System.Text.Encoding.Unicode.GetBytes("")),
                myInstanceII = Engine.x86_64.CreateInstanceW(classCube, System.Text.Encoding.Unicode.GetBytes("secondInstance"));

        System.Diagnostics.Debug.Assert(Engine.x86_64.GetVolume(myInstanceI, (IntPtr) 0, (IntPtr) 0) == 0.0);

        double  length = 2.0;
        Engine.x86_64.SetDatatypeProperty(myInstanceI, propertyLength, ref length, 1);

        IntPtr  instanceNamePtrI = IntPtr.Zero;
        Engine.x86_64.GetNameOfInstanceW(myInstanceI, out instanceNamePtrI);
        string  instanceNameI = System.Runtime.InteropServices.Marshal.PtrToStringUni(instanceNamePtrI);

        length += 1.0;
        Engine.x86_64.SetDatatypeProperty(myInstanceII, propertyLength, ref length, 1);

        IntPtr  instanceNamePtrII = IntPtr.Zero;
        Engine.x86_64.GetNameOfInstanceW(myInstanceII, out instanceNamePtrII);
        string  instanceNameII = System.Runtime.InteropServices.Marshal.PtrToStringUni(instanceNamePtrII);

        Engine.x86_64.SetNameOfInstanceW(myInstanceI, System.Text.Encoding.Unicode.GetBytes("firstInstance"));
        Engine.x86_64.SetNameOfInstanceW(myInstanceII, (string) null);

        System.Diagnostics.Debug.Assert(Engine.x86_64.GetArea(myInstanceI, (IntPtr) 0, (IntPtr) 0) == 24.0);
        System.Diagnostics.Debug.Assert(Engine.x86_64.GetVolume(myInstanceII, (IntPtr) 0, (IntPtr) 0) == 27.0);

        IntPtr  instanceNamePtrIII = IntPtr.Zero;
        Engine.x86_64.GetNameOfInstanceW(myInstanceI, out instanceNamePtrIII);
        string  instanceNameIII = System.Runtime.InteropServices.Marshal.PtrToStringUni(instanceNamePtrIII);

        IntPtr  instanceNamePtrIV = IntPtr.Zero;
        Engine.x86_64.GetNameOfInstanceW(myInstanceII, out instanceNamePtrIV);
        string  instanceNameIV = System.Runtime.InteropServices.Marshal.PtrToStringUni(instanceNamePtrIV);

        //
        //  The retrieved instance names have the following values 
        //      instanceNameI   :  ''
        //      instanceNameII  :  'secondInstance'
        //      instanceNameIII :  'firstInstance'
        //      instanceNameIV  :  null
        //

        //
        //  The resulting model can be viewed in 3D-Editor.exe
        //
        Engine.x86_64.SaveModelW(model, System.Text.Encoding.Unicode.GetBytes("c:\\created\\myFile.bin"));
        Engine.x86_64.CloseModel(model);
    }
}