GetWatchExpressions Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.GetWatchExpressions ( clientSequenceFileParam = NULL, scopingSeqContext = NULL, filterOptions = WatchExpressionFilter_NoOptions)

Return Value

WatchExpressions

Returns an empty list if no watch expressions in the list are valid for the specified scope.

Purpose

Returns a list of references to WatchExpression objects in the watch expression list that the engine maintains. The method returns only objects that match the scope and filter settings specified by the parameters this method contains.

Remarks

A watch expression is global if it is not associated with a client sequence file.

The WatchExpression.ClientSequenceFile, WatchExpression.ExecutionScope, WatchExpression.SequenceFileScope, and WatchExpression.SequenceScope properties specify the scope of a WatchExpression object.

Use the clientSequenceFileParam and the scopingSeqContext parameters of this method to filter the watch expression list. Pass NULL for both of these parameters to return the entire watch expression list. If you pass values for these parameters, TestStand uses the filterOptions parameter to identify which watch expression properties to compare to the parameter values you pass.

Parameters

clientSequenceFileParam As SequenceFile

[In] Specifies a reference to a client sequence file used to identify and limit the watch expressions to return. The method does not return a watch expression if the WatchExpression.ClientSequenceFile property does not match the name of the file this parameter specifies. Pass NULL to instruct the method to not filter watch expressions based on the client sequence file. Pass WatchExpressionFilter_IncludeGlobals in the filterOptions parameter to instruct the method to include watch expressions that specify an empty string for the WatchExpression.ClientSequenceFile property.

This parameter has a default value of NULL.

scopingSeqContext As SequenceContext

[In] Specifies a reference to a sequence context used to identify and limit the watch expressions to return. The method requires a sequence context when you pass WatchExpressionFilter_FilterByExecution, WatchExpressionFilter_FilterBySequence, or WatchExpressionFilter_FilterBySequenceFile to the filterOptions parameter. The method does not return a watch expression if you pass a filter option and the corresponding scope property for the watch expression does not match the given sequence context. The method ignores the filter option for a watch expression if the corresponding scope property does not specify a value. Pass NULL if you do not want the method to exclude watch expressions based on the scoping filter options.

This parameter has a default value of NULL.

filterOptions As Long

[In] Specifies the criteria for filtering the watch expression list. Pass a combination of the WatchExpressionFilterOptions constants. A watch expression must meet all the filter criteria to be included in the returned list.

This parameter has a default value of WatchExpressionFilter_NoOptions.


See Also

SequenceContext

SequenceFile

WatchExpression.ClientSequenceFile

WatchExpression.ExecutionScope

WatchExpression.SequenceFileScope

WatchExpression.SequenceScope

WatchExpressionFilterOptions

WatchExpressions

WAS THIS ARTICLE HELPFUL?

Not Helpful