PropertyObject.GetPropertyObjectElements
- Updated2025-07-21
- 1 minute(s) read
PropertyObject.GetPropertyObjectElements
Syntax
PropertyObject.GetPropertyObjectElements( lookupString, options)
Return Value
Purpose
Returns references to all the array elements of the property you specify in one atomic, thread-safe operation. The property you specify must be an array of containers or this method returns a type mismatch error.Remarks
Use this method to obtain references to all the array elements of an array of containers in one thread while another thread might add, remove, or rename the elements. If you use the PropertyObject.GetNumElements and PropertyObject.GetPropertyObjectByOffset methods while another thread adds or removes the elements, TestStand might return an unexpected error because the number of elements might have changed. The PropertyObject.GetPropertyObjectElements method avoids this issue by atomically obtaining all the references to all the elements in one call.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.
See Also
Thread Safety of the PropertyObject API and TestStand Variables