Syntax

PropertyObject.SetPropertyObjectByOffset( arrayOffset, options, newValue)

Purpose

Sets the array element the arrayOffset parameter specifies to the PropertyObject object you pass.

Remarks

This method is valid only for array objects. For arrays that do not contain objects, such as arrays of numbers, Booleans, strings, or ActiveX references, this method expects a property object of the same type as the array element.

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

arrayOffset As Long

[In] Specifies a zero-based number representing the offset of an array element in the one-dimensional physical storage of the array. The offset is in terms of the number of elements.

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 array element.

See Also

Engine.NewPropertyObject

PropertyObject

PropertyObject.Clone

PropertyObject.GetPropertyObjectByOffset

PropertyObject.SetPropertyObject

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables