Arbortext Command Language > Functions by Alphabetical Listing > com_prop_put
  
com_prop_put
result = com_prop_put(handle, prop, newval[, arg1[, argn]])
Sets the value of a property in a COM object previously attached to using com_attach or one returned by a method called previously.
The handle parameter is a handle returned by a call to com_attach or returned by a previous call to a COM method or property.
The prop parameter is a character string that gives the name of the property to be set.
The newval parameter is the new value for the property.
All other parameters (if any) are parameters for the property. If a property requires an extra parameter, it is most likely an index for an indexed property. Each parameter will be converted to the type expected by the interface being invoked.
Setting a property doesn't normally return a value, but if it does, it will be converted to an appropriate ACL type before being used. If it is a COM interface, it will be converted into a handle to the interface which can be used in subsequent calls to com_call. The handle must be released using com_release when no longer needed.
Example
com_prop_put(doch, "DefaultTabStop", "36.5")
The previous example sets the default tab stop to 36.5 points. Note that when a parameter is a floating point number, you specify it as a string since ACL doesn't have full support for floating point numbers.
Related Topics
com_attach function
com_call function
com_prop_get function
com_release function