PM_SET_OBJECT

Syntax

int_val = PM_SET_OBJECT( object_handle, object_tag_record, invalid_tag );

Input arguments

handle	object_handle	The handle of the target object.
handle	object_tag_record	The handle of the tag record that contains the information to be set to the object.

Output arguments

string

invalid_tag

In case of error, contains the name of the tag whose value triggered the error.

Return Values

Success:

int

0

Successfully set the information to the object.

Failure:

int	-1	Script interface error.
int	MMT_E_OI_UNSUPPORTED_OBJECT_TYPE	'object_type' is not supported.
int	MMT_E_OI_INVALID_GEOMETRY	Object's geometry is not specified correctly.
int	MMT_E_OI_NO_MODIFY_ACCESS	Unable to modify the object.
int	MMT_E_OI_INVALID_REFERENCE_DATA	'invalid_tag' contains a tag that has an unresolved reference.
int	MMT_E_OI_INVALID_DATA	Some tag has an invalid value.

Description

This function sets the data defined with 'object_tag_record' to the object identified by 'object_handle'. See the header file %PMS_HOME%\include\pm_core_tags.h for information on what data you can pass to objects. Notice that you can only set information that is stored to the object itself; you must not attempt to set data that the object inherits from a System, Pipeline, Attribute or Group to which it is assigned. The error codes that the function can return are defined in %PMS_HOME%\include\pm_errors.h.