| GEOS SDK TechDocs | | ObjVarAddData() ... | ObjVarScanData() ...

---

ObjVarDeleteDataAt()

void	ObjVarDeleteDataAt(
        optr	obj,			/* object to delete from */
        word	extraDataOffset);			/* offset to extra data to delete */

This routine deletes the specified vardata entry from the given object's instance chunk. The vardata entry is specified by its pointer as returned by ObjVarAddData() , ObjVarFindData() , and ObjVarDerefData() . To delete an entry specified by its data type, use ObjVarDeleteData() , above.

Warnings: This routine should be called only by the object whose vardata is affected. To operate on other objects' vardata remotely, use messages provided by MetaClass (see below under "See Also").

Include: object.h

See Also: MSG_META_DELETE_VAR_DATA, ObjVarDeleteData().

ObjVarDeleteDataAtHandles()

void	ObjVarDeleteDataAtHandles(
        MemHandle		mh,			/* handle portion of optr */
        ChunkHandle		ch,			/* chunk portion of optr */
        word	extraDataOffset);				/* offset to extra data to delete */

This routine is the same as ObjVarDeleteDataAt() except that the object is specified via its handles rather than its optr.

Include: object.h

ObjVarDeleteDataRange()

void	ObjVarDeleteDataRange(
        optr 		obj,					/* object to delete from */
        word		rangeStart,					/* start of range */
        word		rangeEnd,					/* end of range */
        Boolean		useStateFlag);					/* save to state flag */

This routine deletes all data entries within a given range for the passed object. The range is specified by beginning and ending data types and is inclusive. The four parameters to this routine are

obj

The optr of the object whose data entries are to be deleted.

rangeStart

The lowest number data type to be deleted. Both the VDF_SAVE_TO_STATE flag and the VDF_EXTRA_DATA flag are ignored.

rangeEnd

The highest number data type to be deleted. Both the VDF_SAVE_TO_STATE flag and the VDF_EXTRA_DATA flag are ignored.

useStateFlag

A flag indicating whether entries with their VDF_SAVE_TO_STATE flags should be deleted. Pass true (nonzero) to take the state flag into account; pass false (zero) to delete all entries in the range.

Warnings: This routine should be called only by the object whose vardata is affected. To operate on other objects' vardata remotely, use messages provided by MetaClass (see below under "See Also").

Include: object.h

See Also: MSG_META_DELETE_VAR_DATA.

ObjVarDeleteDataRangeHandles()

void	ObjVarDeleteDataRangeHandles(
        MemHandle		mh,					/* handle portion of optr */
        ChunkHandle		ch,					/* chunk portion of optr */
        word		rangeStart,					/* start of range */
        word		rangeEnd,					/* end of range */
        Boolean		useStateFlag);					/* save to state flag */

This routine is the same as ObjVarDeleteDataRange() except that the object is specified via its handles rather than its optr.

Include: object.h

ObjVarDerefData()

void	* ObjVarDerefData(
        optr		obj,				/* object having data type */
        VardataKey		dataType);				/* data type to dereference */

This routine is exactly like ObjVarFindData() , below, except that it does not return a null pointer if the data type is not found. Do not use this routine unless you are absolutely sure the data type is in the object; otherwise, results are unpredictable.

Include: object.h

See Also: ObjVarFindData().

ObjVarDerefDataHandles()

void	* ObjVarDerefDataHandles(
        MemHandle		mh,				/* handle portion of optr */
        ChunkHandle		ch,				/* chunk portion of optr */
        VardataKey		dataType);				/* data type to dereference */

This routine is the same as ObjVarDerefData() except that the object is specified via its handles rather than its optr.

Include: object.h

ObjVarFindData()

void	* ObjVarFindData(
        optr		obj,				/* object to be checked */
        VardataKey		dataType);				/* data type to find */

This routine searches an object's variable data for a given data type. If the type is found, ObjVarFindData() returns a pointer to the entry's extra data; if the entry has no extra data, an opaque pointer is returned which may be used with ObjVarDeleteDataAt() . If the entry is not found, a null pointer is returned. The pointer returned by this routine must be used before any subsequent operations on the object's block; the pointer may be invalidated by other LMem or object operations.

The two parameters of this routine are

obj

The optr of the object affected. This should be the caller's optr.

dataType

The VardataKey word declaring the data type and its flags. Both the VDF_SAVE_TO_STATE flag and the VDF_EXTRA_DATA flag are ignored.

Warnings: This routine should be called only by the object whose vardata is affected. To operate on other objects' vardata remotely, use messages provided by MetaClass (see below under "See Also").

Include: object.h

See Also: MSG_META_FIND_VAR_DATA.

ObjVarFindDataHandles()

void	* ObjVarFindDataHandles(
        MemHandle		mh,				/* handle portion of optr */
        ChunkHandle		ch,				/* chunk portion of optr */
        VardataKey		dataType);				/* data type to find */

This routine is the same as ObjVarFindData() except that the object is specified via its handles rather than its optr.

Include: object.h