SomBuildClass: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 3: | Line 3: | ||
==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 19: | Line 12: | ||
==Return Code== | ==Return Code== | ||
;rc (SOMClass) : A pointer to a class object. | ;rc (SOMClass) : A pointer to a class object. | ||
==Remarks== | ==Remarks== | ||
Revision as of 21:00, 15 December 2017
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)