PropertyObject.SetValIDispatchByOffset
- Updated2025-07-21
- 1 minute(s) read
PropertyObject.SetValIDispatchByOffset
Syntax
PropertyObject.SetValIDispatchByOffset( arrayOffset, options, newValue)
Purpose
Sets the value of the ActiveX Automation Reference array element the arrayOffset parameter specifies.
Remarks
This method is valid only for array objects. You must specify the value as an IDispatch pointer.
The reference property maintains a reference to the object you specify. If the property already contains a reference, it releases that reference before storing the new one. If you specify a NULL reference, the property releases any existing reference it holds.
This method and the PropertyObject.SetValInterfaceByOffset apply to the PropValType_Reference value type. The PropertyObject.GetValInterface and PropertyObject.SetValInterface methods are intended for use by advanced users who want to store arbitrary interfaces in TestStand reference properties.
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 Object
[In] Specifies the new value for the array element.
See Also
PropertyObject.GetValIDispatchByOffset
PropertyObject.SetValIDispatch
PropertyObject.SetValInterfaceByOffset
Thread Safety of the PropertyObject API and TestStand Variables