InvalidSortSpecification class: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 6: Line 6:
   
   
This exception class has no properties.
This exception class has no properties.
The class's only method is the <var>[[#New constructor)|New]]</var> constructor, which you would typically use with a <var class="product">User Language</var> <var>[[Throw statement|Throw]]</var> statement to produce an <var>InvalidSortSpecification</var> exception. For example:
The class's only method is the <var>[[#New constructor|New]]</var> constructor, which you would typically use with a <var class="product">User Language</var> <var>[[Throw statement|Throw]]</var> statement to produce an <var>InvalidSortSpecification</var> exception. For example:
<p class="code"> throw %(invalidSortSpecification):new
<p class="code"> throw %(invalidSortSpecification):new
</p>
</p>
Line 40: Line 40:
{{Template:InvalidSortSpecification:New subtitle}}
{{Template:InvalidSortSpecification:New subtitle}}
   
   
This callable constructor generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> constructor format follows:
This [[Notation conventions for methods|callable]] constructor generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> constructor format follows:
   
   
<h3>Syntax</h3>
<h3>Syntax</h3>
Line 47: Line 47:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%invalidSortSpecification</th>
<tr><th>%invalidSortSpecification</th>
<td>A reference to the newly created <var>InvalidSortSpecification</var> object.
<td>An <var>InvalidSortSpecification</var> %variable which will refer to the newly created object.
</td></tr>
</td></tr>
<tr><th><var>%(InvalidSortSpecification)</var></th><td>The class name in parentheses denotes a shared method.</td></tr>
<tr><th><var>%(InvalidSortSpecification)</var></th><td>The class name in parentheses denotes a shared method. <var>New</var> can also be invoked via an <var>InvalidSortSpecification</var> object variable, which may be <var>Null</var>.</td></tr>
</table>
</table>
   
   
   
   
[[Category:System exception classes]]
[[Category:System exception classes]]

Revision as of 20:27, 8 June 2011


An InvalidSortSpecification exception indicates that the first argument provided to either the Sort or SortNew method (in the Stringlist class) is not a valid sort specification.

This exception class has no properties. The class's only method is the New constructor, which you would typically use with a User Language Throw statement to produce an InvalidSortSpecification exception. For example:

throw %(invalidSortSpecification):new

Remember that catching an exception is done with the Catch statement; if an exception condition occurs outside a Catch for it, the request is cancelled.

In most cases, a sort specification is part of User Language code, and so should always be correct and request cancellation is an appropriate action. If, however, a sort specification can be entered at least in part by an end user, a Try/Catch block might be appropriate, as shown here:

try %strlist:sort(%sortSpec) catch invalidSortSpecification Print 'Invalid ...' ... end try

The InvalidSortSpecification class is available as of version 7.9.


The InvalidSortSpecification methods

The following are the available InvalidSortSpecification class methods.

MethodDescription
NewCreate a new InvalidSortSpecification object

The methods in the class are described in the subsections that follow. In addition:


New constructor

Create a new InvalidSortSpecification object (InvalidSortSpecification class)

[Introduced in Sirius Mods 7.9]

This callable constructor generates an instance of an InvalidSortSpecification exception. The New constructor format follows:

Syntax

%invalidSortSpecification = [%(InvalidSortSpecification):]New

Syntax terms

%invalidSortSpecification An InvalidSortSpecification %variable which will refer to the newly created object.
%(InvalidSortSpecification)The class name in parentheses denotes a shared method. New can also be invoked via an InvalidSortSpecification object variable, which may be Null.