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: | ||
+ | |||
+ | \\ | ||
+ | =====Description===== | ||
+ | This function creates an error value with the given // | ||
+ | |||
+ | \\ | ||
+ | =====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. | ||
+ | |||
+ | \\ | ||
+ | =====Arguments===== | ||
+ | ^Argument^Type^Description^ | ||
+ | |error_text|Text|The text message shown when the error is displayed.| | ||
+ | |||
+ | **Return value type:** Error/Text | ||
+ | |||
+ | |||
+ | \\ | ||
+ | =====Examples===== | ||
+ | |||
+ | error(' | ||
+ | |||
+ | error(' | ||
+ | |||
+ | if([Value] >= 10, [Value], error(' | ||
+ | |||
+ | \\ | ||
+ | =====See also===== | ||
+ | * [[syntax: | ||
+ | * [[syntax: | ||
+ | * [[syntax: | ||
syntax/functions/error.txt · Last modified: 2021/09/13 20:35 by craigt