CheckExprSyntax Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.CheckExprSyntax ( expressionStr, errorDescription, startErrPos, endErrPos)

Return Value

Boolean

Returns True if the syntax is correct. Returns False if the expression contains a syntax error. If this method returns False, check the errorDescription, startErrPos, and endErrPos parameters for more information.

Purpose

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

Remarks

Calling this method is equivalent to calling the Engine.CheckExpression method and passing a NULL reference to the evaluationContext parameter and passing EvalOption_NoOptions to the evaluationOptions parameter.

Parameters

expressionStr As String

[In] Specifies the expression for which to check the syntax.

errorDescription As String

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

startErrPos As Long

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

endErrPos As Long

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


See Also

Engine.CheckExpression

EvaluationOptions

Expression.ValidateEvaluationType

WAS THIS ARTICLE HELPFUL?

Not Helpful