InvalidValue class: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 3: | Line 3: | ||
The <var>InvalidValue</var> exception class describes an exception associated with not finding an expectedvalue. This exception class has no properties. It is simply a notification that a valid attempt found no values that matched the given string. | The <var>InvalidValue</var> exception class describes an exception associated with not finding an expectedvalue. This exception class has no properties. It is simply a notification that a valid attempt found no values that matched the given string. | ||
To produce an <var>InvalidValue</var> exception yourself, you typically use a <var class="product">User Language</var> <var>[[Throw]]</var> statement with an <var>InvalidValue</var> <var>[[New_(InvalidValue_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an <var>InvalidValue</var> exception: | To produce an <var>InvalidValue</var> exception yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Using the Throw statement|Throw]]</var> statement with an <var>InvalidValue</var> <var>[[New_(InvalidValue_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an <var>InvalidValue</var> exception: | ||
<p class="code">throw %(invalidValue):new | <p class="code">throw %(invalidValue):new | ||
</p> | </p> | ||
Remember that you catch an exception with the <var>[[Catch statement|Catch]]</var> statement; if an exception condition occurs outside a | Remember that you catch an exception with the <var>[[Exceptions#Catch statement|Catch]]</var> statement; if an exception condition occurs outside a | ||
<var>Catch</var> for it, the request is cancelled. | <var>Catch</var> for it, the request is cancelled. | ||
Revision as of 00:05, 10 February 2012
The InvalidValue exception class describes an exception associated with not finding an expectedvalue. This exception class has no properties. It is simply a notification that a valid attempt found no values that matched the given string.
To produce an InvalidValue exception yourself, you typically use a User Language Throw statement with an InvalidValue New constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an InvalidValue exception:
throw %(invalidValue):new
Remember that you catch an exception with the Catch statement; if an exception condition occurs outside a Catch for it, the request is cancelled.
The InvalidValue class is available as of version 7.8.
The InvalidValue methods
The following are the available InvalidValue class methods.
| Method | Description |
|---|---|
| New | Create a new InvalidValue object |
See also
The methods in the class are described in the subsections that follow. In addition:
- "Notation conventions for methods" has information about the conventions followed.
- "InvalidValue methods syntax" is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new InvalidValue object (InvalidValue class)
[Introduced in Sirius Mods 7.8]
This Constructor generates an instance of an InvalidValue exception. The New method format follows:
Syntax
%invalidValue = [%(InvalidValue):]New
Syntax terms
| %invalidValue | A reference to an instance of an InvalidValue object. |
|---|---|
| [%(InvalidValue)] | The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking an InvalidValue 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:
%invalid = new %invalid = %(InvalidValue):new %invalid = %invalid:new