User Tools

Site Tools


syntax:functions:error
no way to compare when less than two revisions

Differences

This shows you the differences between two versions of the page.


Previous revision
syntax:functions:error [2021/09/13 20:35] (current) craigt
Line 1: Line 1:
 +====== 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=====
 +^Argument^Type^Description^
 +|error_text|Text|The 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:iferror|IfError(expression1, expression2)]]
 +  * [[syntax:functions:iserror|IsError(expression)]]
 +  * [[syntax:types|The EasyMorph Type system]]
  
syntax/functions/error.txt · Last modified: 2021/09/13 20:35 by craigt

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki