SomIsObj: Difference between revisions

Revision as of 18:29, 11 October 2017

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)

1    Returns 1 if obj is a pointer to a valid SOM object. 
0    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());
}