Meta information API Calls
File IO / Stream / Copy API Calls
Design Tree Classes API Calls
Design Tree Properties API Calls
Design Tree Instances API Calls
Retrieve Geometry API Calls
Derived Geometry API Calls
Deprecated API Calls
Classes
Object Properties (relations)
Datatype Properties

OpenModel

This function opens the model on location file name.
References inside to other ontologies will be included.
A handle to the model will be returned, or 0 in case something went wrong.

Syntax

C++ 32 bit
C++ 64 bit
C# 32 bit
C# 64 bit
//
//   Strong typing definition
//
OwlModel        OpenModel(
                        const char              * fileName
                    );

static  inline  OwlModel    OpenModel(
                                    char                    * fileName
                                )
{
    return  OpenModel(
                    (const char*) fileName
                );
}


//
//   Weak typing definition
//
int64_t __declspec(dllexport) __stdcall OpenModel(
                                                const char              * fileName
                                            );

static  inline  int64_t OpenModel(
                                char                    * fileName
                            )
{
    return  OpenModel(
                    (const char*) fileName
                );
}

Property fileName

Size: 64 bit / 8 byte (reference)
The file name of the file as available in the file system in ASCII (char *). The given char array will not be adjusted, on each OS the size of a char element is 8 bit / 1 byte.

Example (based on pure API calls)

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

C++ 32 bit
C++ 64 bit
C# 32 bit
C# 64 bit
#include    "./include/engine.h"

int64_t GetFileInstanceCount(char * fileName)
{
    int64_t instanceCount = 0,
            model = OpenModel(fileName);
    
    if (model) {
        int64_t myInstance = GetInstancesByIterator(model, 0);

        while (myInstance) {
            instanceCount++;
            myInstance = GetInstancesByIterator(model, myInstance);
        }

        CloseModel(model);
    }

    return  instanceCount;
}

int main()
{
    int64_t noInstances = GetFileInstanceCount("c:\\created\\myFile.bin");
}