API Component.Property.SetValue

<sidebar>API Contents</sidebar> Sets a components property as a string

Parameters

HANDLE Handle

The component handle of the property owner

STRING Property

The textual name of the property

STRING Value

The value to update the property text with

Return value

This call does not return a value

Detailed description

This sets the internal value of a property, and compliments GetValue.

Note this call does not set the value the property will evaluate to, but sets the value that will be evaluated.

For example, a port connection property may be set to the string "$PORTA", but this call can not be used to change the value of a port.

When code is generated the value of the property becomes fixed for the generated code corresponding to the last call to SetValue().

Examples

Calling in a calculation

• Add to a calculation icon:

  ::Component.Property.SetValue(handle, "property", "value")

No additional examples