ScreenReadError class: Difference between revisions
mNo edit summary |
m (misc cleanup) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
<p class="code">throw %(screenReadError):new | <p class="code">throw %(screenReadError):new | ||
</p> | </p> | ||
The <var>ScreenReadError</var> class is available as of <var class="product">[[Sirius Mods]]</var> version 8.1. | The <var>ScreenReadError</var> class is available as of <var class="product">[[Sirius Mods]]</var> version 8.1. | ||
==The ScreenReadError methods== | ==The ScreenReadError methods== | ||
| Line 16: | Line 13: | ||
The methods in the class are described in the subsections that follow. In addition: | The methods in the class are described in the subsections that follow. In addition: | ||
<ul> | <ul> | ||
<li>[[Notation conventions for methods|Notation conventions for methods]] has information | <li>[[Notation conventions for methods|Notation conventions for methods]] has information about the conventions followed. </li> | ||
about the conventions followed. | |||
<li>[[ScreenReadError methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. | <li>[[ScreenReadError methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li> | ||
</ul> | </ul> | ||
| Line 33: | Line 30: | ||
<tr><th>%screenReadError</th> | <tr><th>%screenReadError</th> | ||
<td>An <var>[[ScreenReadError_class|ScreenReadError]]</var> object variable. | <td>An <var>[[ScreenReadError_class|ScreenReadError]]</var> object variable. </td></tr> | ||
</td></tr> | |||
<tr><th><var>[%(ScreenReadError):]</var></th> | <tr><th><var>[%(ScreenReadError):]</var></th> | ||
Latest revision as of 17:55, 1 September 2015
The ScreenReadError exception class describes an exception associated with
To produce a ScreenReadError exception for yourself, you typically use a SOUL Throw statement with the New ScreenReadError constructor. For example, the following statement throws a ScreenReadError exception:
throw %(screenReadError):new
The ScreenReadError class is available as of Sirius Mods version 8.1.
The ScreenReadError methods
The following are the available ScreenReadError class methods.
| Method | Description |
|---|---|
| New | Create a new ScreenReadError object |
The methods in the class are described in the subsections that follow. In addition:
- Notation conventions for methods has information about the conventions followed.
- ScreenReadError methods syntax is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new ScreenReadError object (ScreenReadError class)
[Introduced in Sirius Mods 8.1]
This Constructor generates an instance of an ScreenReadError exception.
Syntax
%screenReadError = [%(ScreenReadError):]New
Syntax terms
| %screenReadError | An ScreenReadError object variable. |
|---|---|
| [%(ScreenReadError):] | The class name in parentheses denotes a Constructor. See Usage notes, below, for more information about invoking an ScreenReadError Constructor. |
Usage notes
- As described in Using New or other Constructors, New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:
%screenReadErr = new %screenReadErr = %(ScreenReadError):new %screenReadErr = %screenReadErr:new