Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
exit [2015/10/12 00:52] admin [Outputs] |
exit [2026/08/28 03:17] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Exit ====== | + | ====== Exit ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor aborts an execution chain or pipeline. | + | Aborts the execution of the model, optionally showing a message explaining why. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| Line 11: | Line 11: | ||
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | None. | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| + | | Message | [[String Type]] | Message explaining the reason for cancelling the execution. When provided, it is shown to the user; otherwise, the execution is cancelled silently. | None | | ||
| ===== Outputs ===== | ===== Outputs ===== | ||
| Line 21: | Line 22: | ||
| [[Functor List#Control | Control]] | [[Functor List#Control | Control]] | ||
| - | ===== Notes ===== | + | ===== Notes ===== |
| - | + | ||
| - | This is useful in the event the execution chain outputs a logical error. | + | When Message is provided and is not empty once leading and trailing spaces are removed, the execution is aborted and the message is shown to the user as the reason. When Message is left empty, or contains only spaces, the execution is cancelled silently instead. |
| - | ===== Internal Name ===== | + | ===== Internal Name ===== |
| Exit | Exit | ||