ScreenReadError class

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 for the value ABCD:

throw %(screenReadError):new(Name='abcd')

In addition to the New constructor that creates an object instance, the class includes a Name property that returns the invalid statistic name.

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.

Name property

This ReadOnly property returns a string that contains the name of the statistic that is not recognized by the calling method.

Syntax

Syntax terms

%string	This string variable is to contain the name of the unrecognized statistic.
screenReadError	An ScreenReadError object variable.

New constructor

Create a new UnknownStatistic object (UnknownStatistic class)

This Constructor generates an instance of an ScreenReadError exception. As shown below, the required argument of the New method is a specific string value that is not the name of a valid or appropriate Model 204 user statistic for the method that is being called.

Syntax

%screenReadError = [%(ScreenReadError):]New

Syntax terms

%unknownStatistic	An ScreenReadError object variable.
[%(ScreenReadError):]	The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking an UnknownStatistic Constructor.
Name	This name required parameter specifies the string value (string) that is the name of the statistic for which you are providing the exception.

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:

  %unknown = new(Name='MYSTAT') %unknown = %(ScreenReadError):new(Name='MYSTAT') %unknown = %unknown:new(Name='MYSTAT')