PropertyObject.SetPropertyObject

Syntax

PropertyObject.SetPropertyObject( lookupString, options, newValue)

Purpose

Sets the subproperty the lookupString parameter specifies to the PropertyObject object you pass.

Remarks

Do not call this method if another object already contains the object the newValue parameter specifies. For example, if the object you want to specify for the newValue parameter is already a subproperty or an array element of another object, it cannot also be the subproperty of a different object. You can work around this issue by using the PropOption_NotOwning option when you call this method to instead create an alias to the object, by using the PropertyObject.Clone method to make a copy of the object and use the copy instead, or by removing the object from its current parent or array before assigning a new parent.

Parameters

lookupString As String

[In] Pass an empty string to denote the PropertyObject to which the method applies, or pass the name of a subproperty within the PropertyObject. You can also pass lookup strings to this parameter.

options As Long

[In] Pass 0 to specify the default behavior, or pass one or more PropertyOptions constants. Use the bitwise-OR operator to specify multiple options.

newValue As PropertyObject

[In] Specifies the new value for the property.

See Also

Engine.NewPropertyObject

Lookup Strings

PropertyObject

PropertyObject.Clone

PropertyObject.GetPropertyObject

PropertyObject.SetPropertyObjectByOffset

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables