SomBuildClass: Difference between revisions

Revision as of 16:49, 10 March 2017

This function automates the process of building a new SOM class object.

Syntax

unsigned long            inheritVars;
somStaticClassInfoPtr    sciPtr;
long                     majorVersion;
long                     minorVersion;
SOMClass                 rc;

rc = 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.

@@ Line 1: / Line 1: @@
-==Description==
 This function automates the process of building a new SOM class object.
@@ Line 13: / Line 12: @@
 </PRE>
 ==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.
+;sciPtr (somStaticClassInfoPtr) : A pointer to a structure holding static class information.
-; 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.
-; 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.
+;rc (SOMClass) : A pointer to a class object.
 ==Remarks==
@@ Line 33: / Line 28: @@
 ==Related==
 ===Data Structures===
-* [[somStaticClassInfo]] (somapi.h)
+* somStaticClassInfo (somapi.h)
-[[Category:The OS/2 API Project]]
 [[Category:SOM Kernel]]