scpt_raise_error

March 26, 2020 Contributors

Name

scpt_raise_error — triggers an "exception" in the scriptlet runtime

Synopsis

#include "modules/scriptlets/ec_scriptlet.h"

| int **scpt_raise_error** ( | thr, |   |
|   | fmt, |   |
|   | ); |   |

scpt_thread * <var class="pdparam">thr</var>;
const char * <var class="pdparam">fmt</var>;
...;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

triggers an "exception" in the scriptlet runtime

Parameters

thr

The script thread. For a description of this data type see “scpt_thread”.

value

The double that you wish to push.

Return Value

This function returns void.

Threading

It is legal to call this function in any thread.

See Also

Chapter 42, Scriptlet (and Alerting) Functions