PropertyObject.GetSubProperties
- Updated2025-07-21
- 1 minute(s) read
PropertyObject.GetSubProperties
Syntax
PropertyObject.GetSubProperties( lookupString, options)
Return Value
Purpose
Returns references to all the subproperties of the property you specify in one atomic, thread-safe operation.
Remarks
Use this method to obtain references to all the subproperties of a PropertyObject in one thread while another thread might add, remove, or rename the subproperties. If you use the PropertyObject.GetNumSubproperties and PropertyObject.GetNthSubProperty methods while another thread adds or removes the subproperties, TestStand might return an unexpected error because the number of subproperties might have changed. The PropertyObject.GetSubProperties method avoids this issue by atomically obtaining all the references to all the subproperties 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