View source for InvalidRegex class

<!-- InvalidRegex class -->
__NOTOC__
The <var>InvalidRegex</var> exception class describes an exception associated with an invalid [[Regex_processing|regular expression]] being passed to a method that takes a regular expression argument.
 
To produce an <var>InvalidRegex</var> exception yourself, you typically use a <var class="product">User Language</var> <var>[[Throw]]</var> statement with an <var>InvalidRegex</var> <var>[[New_(InvalidRegex_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>InvalidRegex</var> exception with the position set to <code>13</code>, the code set to <code>666</code>, and the description indicating <code>Bad luck</code>:
<p class="code"> [[throw]] %(invalidRegex):new(position=13, code=666, -
                           description='Bad luck')
</p>
 
<h2>The InvalidRegex methods</h2>
{{Template:List of InvalidRegex methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods|"Notation conventions for methods"]] has information
about the conventions followed. 
<li>[[InvalidRegex methods syntax|"InvalidRegex methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
</ul>


<h2>Code property</h2>
{{Template:InvalidRegex:Code subtitle}}

This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property is an integer <var class="term">code</var> that provides some details about the nature of the error.  This <var class="term">code</var> is really only useful to someone familiar with the implementation of the regular expression processor, so it is likely to be useful only to [http://sirius-software.com/support.html Sirius Software technical support].
<p>No assumptions should be made that a particular error will always produce the same <var class="term">code</var> from release to release of the <var class="product">[[Sirius Mods|Sirius Mods]]</var>, or even between runs of an Online.</p>

<h3>Syntax</h3>
{{Template:InvalidRegex:Code syntax}}
<h4>Syntax terms</h4>
<table class="syntaxTable">
<tr><th>%number</th>
<td>This integer value is associated with the regular expression error.
</td></tr>
<tr><th>invalidRegex</th>
<td>A reference to an instance of an <var>[[InvalidRegex_class|InvalidRegex]]</var> object.
</td></tr></table>


<h2>Description property</h2>
{{Template:InvalidRegex:Description subtitle}}

This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property is a text explanation of the problem.  As descriptive text tends to do, this text ''might'' change between releases of the <var class="product">[[Sirius Mods|Sirius Mods]]</var>.

<h3>Syntax</h3>
{{Template:InvalidRegex:Description syntax}}
<h4>Syntax terms</h4>
<table class="syntaxTable">
<tr><th>%string</th>
<td>This string value describes the regular expression error.
</td></tr>
<tr><th>invalidRegex</th>
<td>A reference to an instance of an <var>[[InvalidRegex_class|InvalidRegex]]</var> object.
</td></tr></table>


<h2>New constructor</h2>
{{Template:InvalidRegex:New subtitle}}

This constructor generates an instance of an <var>[[InvalidRegex_class|InvalidRegex]]</var> exception.
<p>As shown below, the required arguments of the <var>New</var> method is the <var>[[Code_(InvalidRegex_property)|Code]]</var>, <var>[[Description_(InvalidRegex_property)|Description]]</var>, and <var>[[Position_(InvalidRegex_property)|Position]]</var> properties.  Each argument to <var>New</var> sets the value of the corresponding property of the newly constructed <var>InvalidRegex</var> object.</p>

<h3>Syntax</h3>
{{Template:InvalidRegex:New syntax}}
<h4>Syntax terms</h4>
<table class="syntaxTable">
<tr><th>%invalidRegex</th>
<td>A reference to an instance of an <var>InvalidRegex</var> object.
</td></tr>
<tr><th><var>%(InvalidRegex)</var></th><td>The class name in parentheses denotes a shared method.</td></tr>
<tr><th><var>Code</var></th>
<td>This [[Methods#Named parameters|name required]] parameter specifies the numeric value (<var class="term">number</var>) to be assigned to the exception object's <var>[[Code_(InvalidRegex_property)|Code]]</var> property.
</td></tr>
<tr><th><var>Description</var></th>
<td>This name required parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[Description_(InvalidRegex_property)|Description]]</var> property.
</td></tr>
<tr><th><var>Position</var></th>
<td>This name required parameter specifies the numeric value (<var class="term">number</var>) to be assigned to the object's <var>[[Position_(InvalidRegex_property)|Position]]</var> property.
</td></tr></table>


<h2>Position property</h2>
{{Template:InvalidRegex:Position subtitle}}

This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property is the position in the [[Regex_processing|regular expression]] determined to be where the regular expression was invalid. It is possible that the mistake was earlier but was not detected until later.

<h3>Syntax</h3>
{{Template:InvalidRegex:Position syntax}}
<h4>Syntax terms</h4>
<table class="syntaxTable">
<tr><th>%number</th>
<td>This numeric value is the position in the regular expression where the error was detected.
</td></tr>
<tr><th>invalidRegex</th>
<td>A reference to an instance of an <var>[[InvalidRegex_class|InvalidRegex]]</var> object.

</td></tr></table>


[[Category:System exception classes]]