CheckExpression Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.CheckExpression ( evaluationContext, expressionStr, evaluationOptions, errorDescription, startErrPos, endErrPos)

Return Value

Boolean

Returns True if the expression is correct. Returns False if the expression contains an error. If it returns False, check the errorDescription, startErrPos, and endErrPos parameters for more information.

Purpose

Checks the validity of the expression parameter and returns error information.

Remarks

This method is similar to the Engine.CheckExprSyntax method, except it checks the validity of variables in the expression.

Parameters

evaluationContext As PropertyObject

[In] Specifies the context in which to evaluate the expression. This method uses this object to determine whether variables in the expression are valid. If you pass a NULL reference, this method checks only the expression syntax.

expressionStr As String

[In] Specifies the expression to check.

evaluationOptions As Long

[In] Pass 0 to specify the default behavior, or pass one or more EvaluationOptions constants. Use the bitwise-OR operator to specify multiple options.

errorDescription As String

[Out] When an error exists, this parameter returns an error message describing the type of error.

startErrPos As Long

[Out] When an error exists, this parameter returns the index of the location in the string where the error begins.

endErrPos As Long

[Out] When an error exists, this parameter returns the index of the location in the string of the first character beyond the error.


See Also

Engine.CheckExprSyntax

EvaluationOptions

Expression.ValidateEvaluationType

PropertyObject

WAS THIS ARTICLE HELPFUL?

Not Helpful