SomEnvironmentNew: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:somEnvironmentNew}} | {{DISPLAYTITLE:somEnvironmentNew}} | ||
This function initializes the SOM runtime environment. | This function initializes the SOM runtime environment. | ||
==Syntax== | ==Syntax== | ||
SOMClassMgr rc; | |||
SOMClassMgr rc; | rc = somEnvironmentNew(); | ||
rc = somEnvironmentNew(); | |||
==Parameters== | ==Parameters== | ||
; rc (SOMClassMgr) | ;rc (SOMClassMgr): A pointer to the single class manager object active at run time. This class manager can be referred by the global variable SOMClassMgrObject. | ||
==Return Code== | ==Return Code== | ||
==Remarks== | ==Remarks== | ||
This function creates the four primitive SOM objects (SOMObject, SOMClass, SOMClassMgr, and SOMClassMgrObject) and initializes global variables used by the SOM run-time environment. This function must be called before using any other SOM functions or methods (with the exception of somSetExpectedIds). If the SOM run-time environment has already been initialized, calling this function has no harmful effect. | This function creates the four primitive SOM objects (SOMObject, SOMClass, SOMClassMgr, and SOMClassMgrObject) and initializes global variables used by the SOM run-time environment. This function must be called before using any other SOM functions or methods (with the exception of somSetExpectedIds). If the SOM run-time environment has already been initialized, calling this function has no harmful effect. | ||
Although this function must be called before using other SOM functions or methods, it needn't always be called explicitly, because the New macros, the Renew macros, the new operator, and the NewClass procedures defined by the SOM C and C++ language bindings call somEnvironmentNew if needed. | Although this function must be called before using other SOM functions or methods, it needn't always be called explicitly, because the New macros, the Renew macros, the new operator, and the NewClass procedures defined by the SOM C and C++ language bindings call somEnvironmentNew if needed. | ||
==Related== | ==Related== | ||
;Functions | |||
* [[somExceptionId]] | * [[somExceptionId]] | ||
* [[somExceptionValue]] | * [[somExceptionValue]] | ||
* [[somSetException]] | * [[somSetException]] | ||
* [[somGetGlobalEnvironment]] | * [[somGetGlobalEnvironment]] | ||
[[Category:SOM function]] | |||
[[Category:SOM | |||
Latest revision as of 04:59, 6 May 2020
This function initializes the SOM runtime environment.
Syntax
SOMClassMgr rc; rc = somEnvironmentNew();
Parameters
- rc (SOMClassMgr)
- A pointer to the single class manager object active at run time. This class manager can be referred by the global variable SOMClassMgrObject.
Return Code
Remarks
This function creates the four primitive SOM objects (SOMObject, SOMClass, SOMClassMgr, and SOMClassMgrObject) and initializes global variables used by the SOM run-time environment. This function must be called before using any other SOM functions or methods (with the exception of somSetExpectedIds). If the SOM run-time environment has already been initialized, calling this function has no harmful effect.
Although this function must be called before using other SOM functions or methods, it needn't always be called explicitly, because the New macros, the Renew macros, the new operator, and the NewClass procedures defined by the SOM C and C++ language bindings call somEnvironmentNew if needed.
Related
- Functions