sos_capi_common.h File Reference

Data type definitions.

Error code definitions.

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

Acquires an optiSLang enterprise license.

Returns

• fmop_settings_error if a license has already been acquired successfully
• fmop_exception_occurred if any error occures while checking out the requested feature(s)
• fmop_success if a license has been acquired successfully

Call FMOP_getErrnoString() to get a human readable representation

Appends another license search path to the default ones.

Deprecated:

By default the following license search paths will be checked in the order given:

• @localhost
• the current working directory
• the path pointed to by the environment variable 'LM_LICENSE_FILE'
• the path pointed to by the environment variable 'DYNARDO_LICENSE_FILE'

Parameters

[in]

abs_path

An absolute file system path, e.g. '/opt/DYNARDO/licensing', 'D:\Licenses', ...

Returns

• fmop_settings_error if the path given does not exist
• fmop_exception_occurred if the path given invoces any other filesystem error
• fmop_success if the path has been appended successfully

Call FMOP_getErrnoString() to get a human readable representation

Returns a string description for the error number given.

Parameters

[in]

error_num

The error number

Returns

A human readable string description for the error number given.The returned string will be overwritten by this function at the next call and will be destroyed on program termination

Note

Calling this function will neither manipulate the internal log message stack nor the errno state of the last library call

DON'T USE ERRNO as agrument identifier as this seems to be defined as a macro identifier Refer to http://www.cplusplus.com/reference/cerrno/errno/ for details

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

Returns

The error number which has been set at the last library call

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

Returns

A human readable string description for the error code that has been set at the last library call. The returned string will be overwritten by this function at the next call and will be destroyed on program termination

Note

Calling this function will neither manipulate the internal log message stack nor the errno state of the last library call

Returns internal log messages of level warning and above.

This log level is immutable. FMOP_setLogLevel() can not modify it. If the internal logger is empty, the value of FMOP_getLastErrnoString() will be returned

Returns

Returns all internal, formatted log messages of log level warning and above if either a warning or an error message occured during the last library call. Otherwise the return value of FMOP_getLastErrnoString() will be returned. The returned string will be overwritten by this function at its next call and will be destroyed on program termination

Note

Calling this function will neither manipulate the internal log message stack nor the errno state of the last library call

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

Initially all log levels are deactivated and no log messages will be buffered. Call FMOP_setLogLevel ( >0 ) to activate the logger and FMOP_setLogLevel (0) to deactivate it again.

Returns

Returns all internal, formatted log messages of the last library call. The returned string will be overwritten by this function at the next call and will be destroyed on program termination

Note

Calling this function will not manipulate the internal log message stack. Though the errno number will be set and can be queried calling FMOP_getLastErrno()

Returns a version string.

Returns

A const pointer to a character array holding the version string. Ownership is handled internally.

Note

Calling this function will not manipulate the internal log message stack. Though the errno number will be set and can be queried calling FMOP_getLastErrno()

Initialize the FMOP library Allocates memory for the global script engine. Call FMOP_unloadLibrary() to release it. A warning is logged if the library was initialized already.

Note

This method must be called once, before requesting the global script engine with FMOP_globalScriptEngine();

Check whether any license feature was acquired.

Returns

True if any license feature is locked, false otherwise

Release the acquired license.

Note, that no previously acquired license is released if not all loaded Database and FMOP objects are already released

Returns

• fmop_settings_error if any Database or FMOP object is not already released
• fmop_success in all other cases

Call FMOP_getErrnoString() to get a human readable representation

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

Parameters

[in]

log_level

Defines the new log level filter for messages returned by FMOP_getLastLog. Accepts the following integer values only: 0 ... filter all log levels 1 ... return only log messages of log level ERROR 2 ... return only log messages of log level WARNING and below 3 ... return only log messages of log level INFO and below 4 ... return only log messages of log level DEBUG and below 5 ... return all log messages, i.e. ERROR, WARNING INFO, DEBUG, TRACE. The log level TRACE is not existing in maintenance, i.e. in customer builds.

Returns

The former log level or -1 if the log_level is unknown

Note

Calling this function will not manipulate the internal log message stack. Though the errno number will be set and can be queried calling FMOP_getLastErrno()