SomIsObj: Difference between revisions
Appearance
No edit summary |
mNo edit summary |
||
Line 3: | Line 3: | ||
==Syntax== | ==Syntax== | ||
somToken memPtr; | |||
somToken memPtr; | boolean rc; | ||
boolean rc; | |||
rc = somIsObj(memPtr); | |||
rc = somIsObj(memPtr); | |||
==Parameters== | ==Parameters== | ||
; memPtr (somToken) : A somToken (a pointer) to be checked. | ;memPtr (somToken): A somToken (a pointer) to be checked. | ||
==Return Code== | ==Return Code== | ||
; rc (boolean) : | ;rc (boolean): | ||
:Returns 1 if obj is a pointer to a valid SOM object. | |||
:Returns 0 if obj is not a pointer to an valid SOM object. | |||
==Remarks== | ==Remarks== | ||
This function returns 1 if its argument is a pointer to a valid SOM object, or returns 0 otherwise. The function handles address faults, and does extensive consistency checking to guarantee a correct result | This function returns 1 if its argument is a pointer to a valid SOM object, or returns 0 otherwise. The function handles address faults, and does extensive consistency checking to guarantee a correct result. | ||
==Example Code== | ==Example Code== | ||
Line 36: | Line 34: | ||
==Related== | ==Related== | ||
;Data Structures | |||
* boolean (somcorba.h) | * boolean (somcorba.h) | ||
* somToken (sombtype.h) | * somToken (sombtype.h) | ||
[[Category:SOM | [[Category:SOM function]] |
Latest revision as of 02:32, 6 May 2020
This function is a failsafe routine to determine whether a pointer references a valid SOM object.
Syntax
somToken memPtr; boolean rc; rc = somIsObj(memPtr);
Parameters
- memPtr (somToken)
- A somToken (a pointer) to be checked.
Return Code
- rc (boolean)
- Returns 1 if obj is a pointer to a valid SOM object.
- Returns 0 if obj is not a pointer to an valid SOM object.
Remarks
This function returns 1 if its argument is a pointer to a valid SOM object, or returns 0 otherwise. The function handles address faults, and does extensive consistency checking to guarantee a correct result.
Example Code
#include <stdio.h> #include <som.xh> void example(void *memPtr) { if (!somIsObj(memPtr)) printf("memPtr is not a valid SOM object.\n"); else printf("memPtr points to an object of class %s\n", ((SOMObject *)memPtr)->somGetClassName()); }
Related
- Data Structures
- boolean (somcorba.h)
- somToken (sombtype.h)