View source for OBJECT GETPROPERTY()

==PURPOSE==
Return an OBJARG format string from a property


==SYNONYM==
None


==SYNOPSIS==
<code lang="c">
#include "dbapi.h"

OBJECT_GETPROPERTY(objptr, propertyname, buffer)

<input parameters>
OBJECT		objptr;		/* Pointer to the object to introspect			*/
char		*propertyname;	/* property name to introspect 			*/

<output parameters>
OBJARG		buffer;		/* pointer to an OBJARG buffer to return result	*/
</code>


==DESCRIPTION==
The OBJECT_GETPROPERTY() macro is used to introspect the specified object and return the property value in an OBJARG format string.


==EXAMPLE==
In the following example OBJECT_GETPROPERTY() is used to return the value of the property "class" in an OBJARG string format returned from introspecting the object ObjValue.

Example Recital program:

<code lang="recital">
test = newobject("myclass")
// Executes method 'define' and updates two properties
? test.define("Error Message", -1000)
? "test.objvalue.errorno",test.objvalue.errorno
? "test.objvalue.message",test.objvalue.message
</code>

Example in 'C' object:

<code lang="c">
#include "dbapi.h"

/* Define define method */
DEFINE_METHOD(clsMyClass, Define) 
{
	struct example_data *objectData = (struct example_data *)OBJECT_GETDATA();
	struct	API_EXPRESSION result;
	char	buffer[512];
	int	rc;

	/* Check the object class */
	OBJECT_GETPROPERTY(objectData->prop_objvalue, "class", buffer);
	rc = OBJECT_GETARG(buffer, &result);
	if (result.errno == 0 && result.type == 'C' &&
		strcmp(result.character, "Exception") == 0) { 
		switch (OBJECT_GETARGC()) {
		case 2: 
		rc = OBJECT_GETPARAMETER(2, &result);
		if (result.errno == 0 && result.type == 'N') {
			OBJECT_SETARG(buffer, &result);
			rc = OBJECT_SETPROPERTY(objectData->prop_objvalue, "errorno", buffer);
		}

		case 1: 
		rc = OBJECT_GETPARAMETER(1, &result);
		if (result.errno == 0 && result.type == 'C') {
			OBJECT_SETARG(buffer, &result);
			rc = OBJECT_SETPROPERTY(objectData->prop_objvalue, "message", buffer);
		}
		break;
		}
	}

	result.type = 'L';
	result.logical = (rc == 0 ? 'T' : 'F');
	OBJECT_RETRESULT(&result);
}
</code>


==SEE ALSO==
[[DEFINE_CLASS()]], [[DEFINE_METHOD()]], [[DEFINE_PROPERTYGET()]], [[DEFINE_PROPERTYSET()]], [[DISPATCH_FACTORY()]], [[DISPATCH_METHOD()]], [[DISPATCH_PROPGET()]], [[DISPATCH_PROPSET()]], [[OBJECT_ASSIGN()]], [[OBJECT_DELETE()]], [[OBJECT_GETARG()]], [[OBJECT_GETARGC()]], [[OBJECT_GETDATA()]], [[OBJECT_GETOBJECT()]], [[OBJECT_GETPARAMETER()]], [[OBJECT_GETTYPE()]], [[OBJECT_GETVALUE()]], [[OBJECT_NEW()]], [[OBJECT_RETERROR()]], [[OBJECT_RETPROPERTY()]], [[OBJECT_RETRESULT()]], [[OBJECT_SETARG()]], [[OBJECT_SETDATA()]], [[OBJECT_SETPROPERTY()]]

[[Category:Documentation]]
[[Category:SDK]]