Syntax

PropertyObject.IsAliasObject( lookupString, options)

Return Value

Boolean

Returns True if the property is an alias.

Purpose

Returns a value that indicates whether the subproperty the lookupString parameter specifies is an alias to another object.

Remarks

An alias object is a property object that references another object or array element.

Create an alias object by using the PropOption_NotOwning option with the PropertyObject.SetPropertyObject or PropertyObject.SetPropertyObjectByOffset methods.

You can also create an alias object by calling the PropertyObject.GetPropertyObject or PropertyObject.GetPropertyObjectByOffset methods on arrays that do not contain objects (such as arrays of numbers, Booleans, strings or ActiveX references), in which case the resulting alias object refers to the specified array element. With the exception of the PropertyObject.Parent property, calling a method or referencing a property on an alias object is equivalent to calling the same method or property on the referenced object or array element unless you pass the PropOption_ReferToAlias option, in which case the method affects the alias object itself. To obtain the referenced object, use the GetPropertyObject method and pass an empty string for the lookupString parameter.

TestStand uses alias objects to make objects appear to have multiple owners. For example, the SequenceContext object contains an alias to the current step. The Step object cannot be a subproperty of the sequence context because it belongs to the sequence instead. By having an alias object that refers to the step, the sequence context appears to contain the step itself.

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

Lookup Strings

PropertyObject.GetPropertyObject

PropertyObject.GetPropertyObjectByOffset

PropertyObject.Parent

PropertyObject.SetPropertyObject

PropertyObject.SetPropertyObjectByOffset

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables