PropertyObject.GetLocation
- Updated2024-10-09
- 1 minute(s) read
PropertyObject.GetLocation
Syntax
PropertyObject.GetLocation( topObject)
Return Value
Returns the lookup string.
Purpose
Returns a lookup string for the property when the topObject parameter specifies a parent of the property. If the topObject parameter does not specify the parent of the property, this method returns the lookup string to the most parent object of the property.
Remarks
Call this method to obtain a lookup string you can use with the object the topObject parameter specifies when topObject is a parent of the property.
Do not use this method to determine the lookup string for a property under a SequenceContext object because the context uses alias objects to reference many properties and the context is not a parent of the property. For example, the expression "StationGlobals.MyBool.GetLocation(ThisContext)" returns "Data.MyBool" , where the "Data" property is the most parent object in the station global variables file.
Parameters
topObject As PropertyObject
[In] Specifies the object that contains this object.
See Also
Thread Safety of the PropertyObject API and TestStand Variables