Navigation:  Object Model Reference > Builder Object >

EvaluateRule method

Previous pageReturn to chapter overviewNext page

Evaluates a step's build rule.

 

Syntax

 

builder.EvaluateRule(ByVal step As IStep, Optional ByVal forDisplay As Boolean = False) As Integer

 

Arguments

 

builder

       Builder object

 

step

       Required.  The step object whose rule is to be evaluated.

 

forDisplay

       Optional.  If True, the results of rule evaluation are not logged and no prompting of undefined macro references will occur.  If False, the rule evaluation will be logged and any undefined macro references will be prompted for.

 

Return value

       The result of the step rule evaluation.  The possible values are:        

Value

Description

0

The rule evaluates to 0 or False.

1

The rule evaluates to 1 or True.

-1

An error occurred evaluating the build rule.

 

See Also

 

Applies to Builder object