failFunction in std

Stop KCL evaluation with a user-defined error.

Added in KCL 3.0.

Use fail when evaluation cannot continue and the caller should receive a specific error message. fail never returns a value.

Arguments

NameTypeDescriptionRequired
msgstringMessage reported to the caller.Yes

Returns

never - The uninhabited type of computations that never complete normally.

Examples