syntax:functions:error
Differences
This shows you the differences between two versions of the page.
syntax:functions:error [2017/12/23 09:53] – created dmitry | syntax:functions:error [2021/09/13 20:35] (current) – craigt | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== error(text) ===== | + | ====== Error(error_text) ====== |
+ | Category: | ||
- | Creates | + | \\ |
+ | =====Description===== | ||
+ | This function creates | ||
- | ^ Example | + | \\ |
- | | error( ' | + | =====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. | ||
- | See also | + | \\ |
- | * [[syntax: | + | =====Arguments===== |
+ | ^Argument^Type^Description^ | ||
+ | |error_text|Text|The text message shown when the error is displayed.| | ||
+ | |||
+ | **Return value type:** Error/ | ||
+ | |||
+ | |||
+ | \\ | ||
+ | =====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