## On this page

  

 

 # sos\_capi\_common

 Last update: 22.02.2024 

[Go to the documentation of this file.](sos__capi__common_8h.xhtml)<a id="l00001" name="l00001"></a> 1 

<a id="l00002" name="l00002"></a> 2 \#ifndef DYNARDO\_SOS\_CAPI\_COMMON\_H

<a id="l00003" name="l00003"></a> 3  #define DYNARDO\_SOS\_CAPI\_COMMON\_H

<a id="l00004" name="l00004"></a> 4 

<a id="l00006" name="l00006"></a> 6 

<a id="l00007" name="l00007"></a> 7 // Generic helper definitions for shared library support

<a id="l00008" name="l00008"></a> 8 //#if (defined \_WIN32 || defined \_\_CYGWIN\_\_) &amp;&amp; (not defined MINGW)

<a id="l00009" name="l00009"></a> 9 \#if defined \_WIN32 || defined \_\_CYGWIN\_\_

<a id="l00010" name="l00010"></a> 10  #define DYNARDO\_HELPER\_DLL\_IMPORT \_\_declspec(dllimport)

<a id="l00011" name="l00011"></a> 11  #define DYNARDO\_HELPER\_DLL\_EXPORT \_\_declspec(dllexport)

<a id="l00012" name="l00012"></a> 12  #define DYNARDO\_HELPER\_DLL\_LOCAL

<a id="l00013" name="l00013"></a> 13 \#else

<a id="l00014" name="l00014"></a> 14  #if \_\_GNUC\_\_ &gt;= 4

<a id="l00015" name="l00015"></a> 15  #define DYNARDO\_HELPER\_DLL\_IMPORT \_\_attribute\_\_ ((visibility ("default")))

<a id="l00016" name="l00016"></a> 16  #define DYNARDO\_HELPER\_DLL\_EXPORT \_\_attribute\_\_ ((visibility ("default")))

<a id="l00017" name="l00017"></a> 17  #define DYNARDO\_HELPER\_DLL\_LOCAL \_\_attribute\_\_ ((visibility ("hidden")))

<a id="l00018" name="l00018"></a> 18  #else

<a id="l00019" name="l00019"></a> 19  #define DYNARDO\_HELPER\_DLL\_IMPORT

<a id="l00020" name="l00020"></a> 20  #define DYNARDO\_HELPER\_DLL\_EXPORT

<a id="l00021" name="l00021"></a> 21  #define DYNARDO\_HELPER\_DLL\_LOCAL

<a id="l00022" name="l00022"></a> 22  #endif

<a id="l00023" name="l00023"></a> 23 \#endif

<a id="l00024" name="l00024"></a> 24 

<a id="l00025" name="l00025"></a> 25 // Now we use the generic helper definitions above to define DYNARDO\_FMOP\_API and DYNARDO\_FMOP\_LOCAL.

<a id="l00026" name="l00026"></a> 26 // DYNARDO\_FMOP\_API is used for the public API symbols. It either DLL imports or DLL exports (or does nothing

<a id="l00027" name="l00027"></a> 27 // for static build)

<a id="l00028" name="l00028"></a> 28 // DYNARDO\_FMOP\_LOCAL is used for non-api symbols.

<a id="l00029" name="l00029"></a> 29 

<a id="l00030" name="l00030"></a> 30 \#ifdef DYNARDO\_DLL // defined if the library is compiled as a DLL

<a id="l00031" name="l00031"></a> 31  #ifdef DYNARDO\_FMOP\_DLL\_EXPORTS // defined if we are building the DYNARDO DLL (instead of using it)

<a id="l00032" name="l00032"></a> 32  #define DYNARDO\_FMOP\_API DYNARDO\_HELPER\_DLL\_EXPORT

<a id="l00033" name="l00033"></a> 33  #else

<a id="l00034" name="l00034"></a> 34  #define DYNARDO\_FMOP\_API DYNARDO\_HELPER\_DLL\_IMPORT

<a id="l00035" name="l00035"></a> 35  #endif // DYNARDO\_FMOP\_DLL\_EXPORTS

<a id="l00036" name="l00036"></a> 36  #define DYNARDO\_FMOP\_LOCAL DYNARDO\_HELPER\_DLL\_LOCAL

<a id="l00037" name="l00037"></a> 37 \#else // DYNARDO\_DLL is not defined: this means we compile a static lib.

<a id="l00038" name="l00038"></a> 38  #define DYNARDO\_FMOP\_API

<a id="l00039" name="l00039"></a> 39  #define DYNARDO\_FMOP\_LOCAL

<a id="l00040" name="l00040"></a> 40 \#endif // DYNARDO\_DLL

<a id="l00041" name="l00041"></a> 41 

<a id="l00042" name="l00042"></a> 42 \#ifndef \_\_cplusplus

<a id="l00043" name="l00043"></a> 43  #if defined(\_\_STDC\_VERSION\_\_) &amp;&amp; \_\_STDC\_VERSION\_\_ &gt;= 199901L

<a id="l00044" name="l00044"></a> 44  #include &lt;stdbool.h&gt;

<a id="l00045" name="l00045"></a> 45  #elif !defined(false) &amp;&amp; !defined(true)

<a id="l00046" name="l00046"></a> 46 typedef int bool;

<a id="l00047" name="l00047"></a> 47  #define false 0

<a id="l00048" name="l00048"></a> 48  #define true 1

<a id="l00049" name="l00049"></a> 49  #endif

<a id="l00050" name="l00050"></a> 50  #include &lt;stddef.h&gt;

<a id="l00051" name="l00051"></a> 51 \#else

<a id="l00052" name="l00052"></a> 52  #include &lt;cstddef&gt;

<a id="l00053" name="l00053"></a> 53 \#endif

<a id="l00054" name="l00054"></a> 54 

<a id="l00055" name="l00055"></a> 55 

<a id="l00056" name="l00056"></a> 56 

<a id="l00057" name="l00057"></a> 57 \#ifdef \_\_cplusplus

<a id="l00058" name="l00058"></a> 58 extern "C" {

<a id="l00059" name="l00059"></a> 59 \#endif

<a id="l00060" name="l00060"></a> 60 

<a id="l00062" name="l00062"></a> 62 

<a id="l00067" name="l00067"></a> 67 

<a id="l00068" name="l00068"></a> 68 /\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/

<a id="l00075" name="l00075"></a> 75 

<a id="l00079" name="l00079"></a>[ 79](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec) typedef enum

<a id="l00080" name="l00080"></a> 80 {

<a id="l00081" name="l00081"></a>[ 81](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca41a0a2e83b0ac20d414f4b015522ce55) [fmop\_success](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca41a0a2e83b0ac20d414f4b015522ce55) = 0, 

<a id="l00082" name="l00082"></a>[ 82](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becacef5c059b0dd649f97d5404db95c3ccf) [fmop\_invalid\_handle](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becacef5c059b0dd649f97d5404db95c3ccf) = 1, 

<a id="l00083" name="l00083"></a>[ 83](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becadac3d9086cdab852d265dc924070c198) [fmop\_exception\_occurred](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becadac3d9086cdab852d265dc924070c198) = 2, 

<a id="l00084" name="l00084"></a>[ 84](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca4040927e4d05d13e93b9f2c7373ca0cd) [fmop\_settings\_error](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca4040927e4d05d13e93b9f2c7373ca0cd) = 3, 

<a id="l00085" name="l00085"></a>[ 85](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becaedda7a6dbd4f5dd3eedecca9ec7dc1e9) [fmop\_model\_missing](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becaedda7a6dbd4f5dd3eedecca9ec7dc1e9) = 4, 

<a id="l00086" name="l00086"></a>[ 86](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becacf8dfe2eaba2eada73a26e487a04f8fe) [fmop\_license\_error](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becacf8dfe2eaba2eada73a26e487a04f8fe) = 5, 

<a id="l00087" name="l00087"></a>[ 87](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becab6e0160bb71d6930176d907409618f4d) [fmop\_script\_error](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becab6e0160bb71d6930176d907409618f4d) = 6, 

<a id="l00088" name="l00088"></a>[ 88](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca749f1c6edf13b1303018d7a3632dc316) [fmop\_script\_no\_object](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca749f1c6edf13b1303018d7a3632dc316) = 7, 

<a id="l00089" name="l00089"></a>[ 89](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca32eddc7d860101cdbb8e1571c726ee91) [fmop\_script\_wrong\_type](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca32eddc7d860101cdbb8e1571c726ee91) = 8, 

<a id="l00090" name="l00090"></a> 90 

<a id="l00091" name="l00091"></a>[ 91](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca7fc167a096db0f31209791e0053de2ec) [fmop\_not\_implemented](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca7fc167a096db0f31209791e0053de2ec) = 16382, 

<a id="l00092" name="l00092"></a> 92 

<a id="l00093" name="l00093"></a> 93 [fmop\_const\_max](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca41b2d8995eb66857227a50e49e8f6016) = 16383 

<a id="l00094" name="l00094"></a> 94 

<a id="l00095" name="l00095"></a>[ 95](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca41b2d8995eb66857227a50e49e8f6016) } [fmop\_error\_t](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec);

<a id="l00096" name="l00096"></a> 96 

<a id="l00100" name="l00100"></a>[ 100](sos__capi__common_8h.xhtml#afe21e382a604ef55cba4d683d706422e) typedef enum

<a id="l00101" name="l00101"></a> 101 {

<a id="l00102" name="l00102"></a> 102 // Mesh related features

<a id="l00103" name="l00103"></a> 103 // Predefined feature combinations

<a id="l00104" name="l00104"></a>[ 104](sos__capi__common_8h.xhtml#afe21e382a604ef55cba4d683d706422ea5b9372ca962a29cf37faac2948897143) [fmop\_mesh\_signal](sos__capi__common_8h.xhtml#afe21e382a604ef55cba4d683d706422ea5b9372ca962a29cf37faac2948897143) = 10, 

<a id="l00105" name="l00105"></a> 105 [fmop\_mesh\_all](sos__capi__common_8h.xhtml#afe21e382a604ef55cba4d683d706422ea71a41e6fb1935010b6ed34037f7dae8c) = 30 

<a id="l00106" name="l00106"></a>[ 106](sos__capi__common_8h.xhtml#afe21e382a604ef55cba4d683d706422ea71a41e6fb1935010b6ed34037f7dae8c) } [fmop\_license\_t](sos__capi__common_8h.xhtml#afe21e382a604ef55cba4d683d706422e);

<a id="l00107" name="l00107"></a> 107 

<a id="l00111" name="l00111"></a>[ 111](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75) typedef enum

<a id="l00112" name="l00112"></a> 112 {

<a id="l00113" name="l00113"></a>[ 113](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75aaf0fb275c161febc56c4f10e62987049) [fmop\_node\_data](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75aaf0fb275c161febc56c4f10e62987049) = 0, 

<a id="l00114" name="l00114"></a>[ 114](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75a1ec31fe31f3b8a9fd9dd902b014499ef) [fmop\_element\_data](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75a1ec31fe31f3b8a9fd9dd902b014499ef) = 1, 

<a id="l00115" name="l00115"></a> 115 [fmop\_scalar\_data](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75a16a14aa0d55901638e165fb3a39b3870) = 3 

<a id="l00116" name="l00116"></a>[ 116](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75a16a14aa0d55901638e165fb3a39b3870) } [fmop\_dataobject\_types](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75);

<a id="l00117" name="l00117"></a> 117 

<a id="l00118" name="l00118"></a> 118 

<a id="l00120" name="l00120"></a> 120 

<a id="l00121" name="l00121"></a> 121 /\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/

<a id="l00127" name="l00127"></a> 127 

<a id="l00145" name="l00145"></a>[ 145](sos__capi__common_8h.xhtml#a7086f4db3e639526b2b7fe9ce9392a24) DYNARDO_FMOP_API [fmop\_error\_t](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec) [FMOP\_appendLicenseSearchPath](sos__capi__common_8h.xhtml#a7086f4db3e639526b2b7fe9ce9392a24) ( const char * abs_path );

<a id="l00156" name="l00156"></a>[ 156](sos__capi__common_8h.xhtml#a1cdd0d44e0ea8172b1f7f1095395da89) DYNARDO_FMOP_API [fmop\_error\_t](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec) [FMOP\_acquireLicense](sos__capi__common_8h.xhtml#a1cdd0d44e0ea8172b1f7f1095395da89) ( );

<a id="l00161" name="l00161"></a>[ 161](sos__capi__common_8h.xhtml#a462a99c932a9b5704aae42a15826e4c3) DYNARDO_FMOP_API bool [FMOP\_licenseLocked](sos__capi__common_8h.xhtml#a462a99c932a9b5704aae42a15826e4c3) ();

<a id="l00173" name="l00173"></a>[ 173](sos__capi__common_8h.xhtml#a62d038d686a8183e10f52131697bce6c) DYNARDO_FMOP_API [fmop\_error\_t](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec) [FMOP\_releaseLicense](sos__capi__common_8h.xhtml#a62d038d686a8183e10f52131697bce6c) ();

<a id="l00174" name="l00174"></a> 174 

<a id="l00176" name="l00176"></a> 176 

<a id="l00177" name="l00177"></a> 177 

<a id="l00178" name="l00178"></a> 178 /\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/

<a id="l00184" name="l00184"></a> 184 

<a id="l00199" name="l00199"></a>[ 199](sos__capi__common_8h.xhtml#a5e19e7fe152759a80115e908c593245d) DYNARDO_FMOP_API const char* [FMOP\_getLastErrorString](sos__capi__common_8h.xhtml#a5e19e7fe152759a80115e908c593245d) ();

<a id="l00205" name="l00205"></a>[ 205](sos__capi__common_8h.xhtml#ac78d83f9f73afd90854e1d07657fc186) DYNARDO_FMOP_API [fmop\_error\_t](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec) [FMOP\_getLastErrno](sos__capi__common_8h.xhtml#ac78d83f9f73afd90854e1d07657fc186) ();

<a id="l00215" name="l00215"></a>[ 215](sos__capi__common_8h.xhtml#aa838a7c375fc1d01d51636ad52a182ad) DYNARDO_FMOP_API const char* [FMOP\_getLastErrnoString](sos__capi__common_8h.xhtml#aa838a7c375fc1d01d51636ad52a182ad) ();

<a id="l00216" name="l00216"></a> 216 

<a id="l00229" name="l00229"></a>[ 229](sos__capi__common_8h.xhtml#ad78d4b2f659d76cce9d16eb7b0e10e2c) DYNARDO_FMOP_API const char* [FMOP\_getLastLogString](sos__capi__common_8h.xhtml#ad78d4b2f659d76cce9d16eb7b0e10e2c) ();

<a id="l00246" name="l00246"></a>[ 246](sos__capi__common_8h.xhtml#ac13c87c4e4d30a83f4d041a908d0a1e7) DYNARDO_FMOP_API int [FMOP\_setLogLevel](sos__capi__common_8h.xhtml#ac13c87c4e4d30a83f4d041a908d0a1e7) ( int log_level );

<a id="l00247" name="l00247"></a> 247 

<a id="l00259" name="l00259"></a>[ 259](sos__capi__common_8h.xhtml#a7e820b85d2ef2596b00bc82445dcf650) DYNARDO_FMOP_API const char* [FMOP\_getErrnoString](sos__capi__common_8h.xhtml#a7e820b85d2ef2596b00bc82445dcf650) ( [fmop\_error\_t](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec) error_num );

<a id="l00260" name="l00260"></a> 260 

<a id="l00262" name="l00262"></a> 262 

<a id="l00263" name="l00263"></a> 263 /\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/

<a id="l00268" name="l00268"></a> 268 

<a id="l00275" name="l00275"></a>[ 275](sos__capi__common_8h.xhtml#a4f2de6ba4f98c98d1c670fa4a9117150) DYNARDO_FMOP_API const char* [FMOP\_getVersionString](sos__capi__common_8h.xhtml#a4f2de6ba4f98c98d1c670fa4a9117150) ();

<a id="l00276" name="l00276"></a> 276 

<a id="l00278" name="l00278"></a> 278 

<a id="l00279" name="l00279"></a> 279 /\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/

<a id="l00284" name="l00284"></a> 284 

<a id="l00289" name="l00289"></a>[ 289](sos__capi__common_8h.xhtml#a9c8f0f808d3f27c57a3a57d5f9cf4834) DYNARDO_FMOP_API [fmop\_error\_t](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec) [FMOP\_initializeLibrary](sos__capi__common_8h.xhtml#a9c8f0f808d3f27c57a3a57d5f9cf4834)();

<a id="l00293" name="l00293"></a>[ 293](sos__capi__common_8h.xhtml#ae0af273cc642061f90933b4af2a958ad) DYNARDO_FMOP_API [fmop\_error\_t](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec) [FMOP\_unloadLibrary](sos__capi__common_8h.xhtml#ae0af273cc642061f90933b4af2a958ad)();

<a id="l00294" name="l00294"></a> 294 

<a id="l00295" name="l00295"></a> 295 \#ifdef \_\_cplusplus

<a id="l00296" name="l00296"></a> 296 }

<a id="l00297" name="l00297"></a> 297 \#endif

<a id="l00298" name="l00298"></a> 298 

<a id="l00299" name="l00299"></a> 299 \#endif // DYNARDO\_SOS\_CAPI\_COMMON\_H

<a id="l00300" name="l00300"></a> 300 

<a id="l00301" name="l00301"></a> 301 // (c) 2017, DYNARDO Austria GmbH (proprietary license)

[FMOP\_acquireLicense](sos__capi__common_8h.xhtml#a1cdd0d44e0ea8172b1f7f1095395da89)

DYNARDO_FMOP_API fmop_error_t FMOP_acquireLicense()

Acquires an optiSLang enterprise license.



[FMOP\_licenseLocked](sos__capi__common_8h.xhtml#a462a99c932a9b5704aae42a15826e4c3)

DYNARDO_FMOP_API bool FMOP_licenseLocked()

Check whether any license feature was acquired.



[fmop\_error\_t](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8bec)

fmop_error_t

Error code definitions.

**Definition:** sos_capi_common.h:80



[fmop\_script\_wrong\_type](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca32eddc7d860101cdbb8e1571c726ee91)

@ fmop_script_wrong_type

Object with ident has wrong type.

**Definition:** sos_capi_common.h:89



[fmop\_settings\_error](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca4040927e4d05d13e93b9f2c7373ca0cd)

@ fmop_settings_error

Input argument(s) is invalid or missing.

**Definition:** sos_capi_common.h:84



[fmop\_success](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca41a0a2e83b0ac20d414f4b015522ce55)

@ fmop_success

Function execution returned successfully.

**Definition:** sos_capi_common.h:81



[fmop\_const\_max](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca41b2d8995eb66857227a50e49e8f6016)

@ fmop_const_max

2^14-1 non-modifiable for each API version

**Definition:** sos_capi_common.h:93



[fmop\_script\_no\_object](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca749f1c6edf13b1303018d7a3632dc316)

@ fmop_script_no_object

Object with ident not found in script engine.

**Definition:** sos_capi_common.h:88



[fmop\_not\_implemented](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8beca7fc167a096db0f31209791e0053de2ec)

@ fmop_not_implemented

This function is yet not implemented or has been removed.

**Definition:** sos_capi_common.h:91



[fmop\_script\_error](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becab6e0160bb71d6930176d907409618f4d)

@ fmop_script_error

An error appeare while executing Lua script.

**Definition:** sos_capi_common.h:87



[fmop\_invalid\_handle](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becacef5c059b0dd649f97d5404db95c3ccf)

@ fmop_invalid_handle

The function got an unexpected NULL pointer.

**Definition:** sos_capi_common.h:82



[fmop\_license\_error](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becacf8dfe2eaba2eada73a26e487a04f8fe)

@ fmop_license_error

No valid license available.

**Definition:** sos_capi_common.h:86



[fmop\_exception\_occurred](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becadac3d9086cdab852d265dc924070c198)

@ fmop_exception_occurred

An internal error occurred. Request log messages.

**Definition:** sos_capi_common.h:83



[fmop\_model\_missing](sos__capi__common_8h.xhtml#a4847f3fa2943ffd694eb6cbe169a8becaedda7a6dbd4f5dd3eedecca9ec7dc1e9)

@ fmop_model_missing

The requested model identifier is not known.

**Definition:** sos_capi_common.h:85



[FMOP\_getVersionString](sos__capi__common_8h.xhtml#a4f2de6ba4f98c98d1c670fa4a9117150)

DYNARDO_FMOP_API const char * FMOP_getVersionString()

Returns a version string.



[FMOP\_getLastErrorString](sos__capi__common_8h.xhtml#a5e19e7fe152759a80115e908c593245d)

DYNARDO_FMOP_API const char * FMOP_getLastErrorString()

Returns internal log messages of level warning and above.



[FMOP\_releaseLicense](sos__capi__common_8h.xhtml#a62d038d686a8183e10f52131697bce6c)

DYNARDO_FMOP_API fmop_error_t FMOP_releaseLicense()

Release the acquired license.



[fmop\_dataobject\_types](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75)

fmop_dataobject_types

Data type definitions.

**Definition:** sos_capi_common.h:112



[fmop\_scalar\_data](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75a16a14aa0d55901638e165fb3a39b3870)

@ fmop_scalar_data

scalar data (vector of size 1)

**Definition:** sos_capi_common.h:115



[fmop\_element\_data](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75a1ec31fe31f3b8a9fd9dd902b014499ef)

@ fmop_element_data

element data (one scalar per element)

**Definition:** sos_capi_common.h:114



[fmop\_node\_data](sos__capi__common_8h.xhtml#a69eb42c1b3b49f22b9e73c6c9869cb75aaf0fb275c161febc56c4f10e62987049)

@ fmop_node_data

node data (one scalar per node)

**Definition:** sos_capi_common.h:113



[FMOP\_appendLicenseSearchPath](sos__capi__common_8h.xhtml#a7086f4db3e639526b2b7fe9ce9392a24)

DYNARDO_FMOP_API fmop_error_t FMOP_appendLicenseSearchPath(const char *abs_path)

Appends another license search path to the default ones.



[FMOP\_getErrnoString](sos__capi__common_8h.xhtml#a7e820b85d2ef2596b00bc82445dcf650)

DYNARDO_FMOP_API const char * FMOP_getErrnoString(fmop_error_t error_num)

Returns a string description for the error number given.



[FMOP\_initializeLibrary](sos__capi__common_8h.xhtml#a9c8f0f808d3f27c57a3a57d5f9cf4834)

DYNARDO_FMOP_API fmop_error_t FMOP_initializeLibrary()

Initialize the FMOP library Allocates memory for the global script engine. Call FMOP_unloadLibrary() ...



[FMOP\_getLastErrnoString](sos__capi__common_8h.xhtml#aa838a7c375fc1d01d51636ad52a182ad)

DYNARDO_FMOP_API const char * FMOP_getLastErrnoString()

Returns a pointer to a string that describes the error code which has been set at the last library ca...



[FMOP\_setLogLevel](sos__capi__common_8h.xhtml#ac13c87c4e4d30a83f4d041a908d0a1e7)

DYNARDO_FMOP_API int FMOP_setLogLevel(int log_level)

Defines the new log level filter. Valid for all subsequent library calls until a new log level gets s...



[FMOP\_getLastErrno](sos__capi__common_8h.xhtml#ac78d83f9f73afd90854e1d07657fc186)

DYNARDO_FMOP_API fmop_error_t FMOP_getLastErrno()

Returns the error number which has been set at the last library call.



[FMOP\_getLastLogString](sos__capi__common_8h.xhtml#ad78d4b2f659d76cce9d16eb7b0e10e2c)

DYNARDO_FMOP_API const char * FMOP_getLastLogString()

Returns internal log messages of log levels defined by FMOP_setLogLevel. Serves as debug logger.



[FMOP\_unloadLibrary](sos__capi__common_8h.xhtml#ae0af273cc642061f90933b4af2a958ad)

DYNARDO_FMOP_API fmop_error_t FMOP_unloadLibrary()

Unload the FMOP library Clears the FMOP library from memory. A warning is logged if the library was u...



[fmop\_license\_t](sos__capi__common_8h.xhtml#afe21e382a604ef55cba4d683d706422e)

fmop_license_t

FMOP mesh features which need to be unlocked by a valid license.

**Definition:** sos_capi_common.h:101



[fmop\_mesh\_signal](sos__capi__common_8h.xhtml#afe21e382a604ef55cba4d683d706422ea5b9372ca962a29cf37faac2948897143)

@ fmop_mesh_signal

Unlocks signal meshes.

**Definition:** sos_capi_common.h:104



[fmop\_mesh\_all](sos__capi__common_8h.xhtml#afe21e382a604ef55cba4d683d706422ea71a41e6fb1935010b6ed34037f7dae8c)

@ fmop_mesh_all

Unlocks all mesh features.

**Definition:** sos_capi_common.h:105