User Tools

Site Tools


syntax:functions:error

Error(error_text)

Category: Special function


Description

This function creates an error value with the given error_text.


Use cases

Use this function to raise an error when a known situation occurs that could cause issues downstream, and should not be permitted to continue. i.e., empty datasets, values outside expected parameters, etc.


Arguments

ArgumentTypeDescription
error_textTextThe text message shown when the error is displayed.

Return value type: Error/Text


Examples

error('Something went wrong')  //Returns '#Something went wrong'
error('Dataset is empty')  //Returns '#Dataset is empty'
if([Value] >= 10, [Value], error('Minimum value is 10') )  //Returns the error if [Value] is below 10.


See also

syntax/functions/error.txt · Last modified: 2021/09/13 20:35 by craigt