SomBuildClass: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This function automates the process of building a new SOM class object. | {{DISPLAYTITLE:somBuildClass}} | ||
This function automates the process of building a new SOM class object. | |||
==Syntax== | ==Syntax== | ||
somBuildClass(inheritVars, sciPtr, majorVersion, minorVersion) | |||
==Parameters== | ==Parameters== | ||
;inheritVars (unsigned long) : A bit mask that determines inheritance from parent classes. A mask containing all ones is an appropriate default. | ;inheritVars (unsigned long) : A bit mask that determines inheritance from parent classes. A mask containing all ones is an appropriate default. | ||
| Line 18: | Line 12: | ||
==Return Code== | ==Return Code== | ||
;rc (SOMClass) : A pointer to a class object. | ;rc (SOMClass) : A pointer to a class object. | ||
==Remarks== | ==Remarks== | ||
This function accepts declarative information defining a new class that is be built, and performs the activities required to build and register a correctly functioning class object. The C and C++ implementation bindings use this function to create class objects. | This function accepts declarative information defining a new class that is be built, and performs the activities required to build and register a correctly functioning class object. The C and C++ implementation bindings use this function to create class objects. | ||
==Example Code== | ==Example Code== | ||
| Line 27: | Line 21: | ||
==Related== | ==Related== | ||
;Data Structures | |||
* somStaticClassInfo (somapi.h) | * somStaticClassInfo (somapi.h) | ||
[[Category:SOM | [[Category:SOM function]] | ||
Latest revision as of 02:24, 6 May 2020
This function automates the process of building a new SOM class object.
Syntax
somBuildClass(inheritVars, sciPtr, majorVersion, minorVersion)
Parameters
- inheritVars (unsigned long)
- A bit mask that determines inheritance from parent classes. A mask containing all ones is an appropriate default.
- sciPtr (somStaticClassInfoPtr)
- A pointer to a structure holding static class information.
- majorVersion (long)
- The major version number for the class.
- minorVersion (long)
- The minor version number for the class.
Return Code
- rc (SOMClass)
- A pointer to a class object.
Remarks
This function accepts declarative information defining a new class that is be built, and performs the activities required to build and register a correctly functioning class object. The C and C++ implementation bindings use this function to create class objects.
Example Code
See any .ih or .xih implementation binding file for details on construction of the required data structures.
Related
- Data Structures
- somStaticClassInfo (somapi.h)