IsEqualTo Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

PropertyObject.IsEqualTo ( objectToCompare, options)

Return Value

Boolean

Purpose

Compares this object to another PropertyObject.

Remarks

With no options, this method returns True if both objects have the same number of subproperties with the same case-insensitive names, value types, representation, values, flags, and attributes. If both objects are type definitions, the struct/cluster passing settings, type flags, instance default flags, instance override flags, type versions, type definition lock settings, and type attributes must also be the same.

If a subproperty enables the PropFlags_ExcludeFromComparison flag, TestStand ignores the subproperty for purposes of this comparison.

If you specify the PropOption_RequireIdenticalStructure option, additional settings for the properties must be the same. If you specify the PropOption_CaseInsensitive option, the method ignores case differences when comparing string values.

Parameters

objectToCompare As PropertyObject

[In] Specifies the object to compare to this object.

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.

You typically use the PropOption_CaseInsensitive, PropOption_DoNotRecurse, and PropOption_RequireIdenticalStructure options with this method.


See Also

PropertyFlags

PropertyObject

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables

WAS THIS ARTICLE HELPFUL?

Not Helpful