SetReturnValue

Syntax

bool SetReturnValue (StrParam)

Parameters

True: The action will return true.

False: The action will return false.

Returns

True if the action is passed the parameter true. Otherwise, False.

Level

All.

Details

This action will return true or false based on the input parameter.

By passing in true, the action will return true and continue with the actions in the current function. If this is the last action in a function, any following functions within the rule are skipped.

One use for this action is a quick way to disable a rule by adding a new function, that precedes all other functions in the rule, where the new function contains only this action with a parameter of true. This will cause all other functions in the rule to be skipped and the next rule will run.

Using a parameter of false, this action will return false, causing all following actions in the function to be skipped and control carries forward to the next function in the same rule. In this way, the operation is identical to the action GoToNextFunction.

Example

SetReturnValue("true")