InvalidDeflateData class: Difference between revisions
m (link repair) |
m (misc cleanup) |
||
| Line 10: | Line 10: | ||
<var>Catch</var> for it, the request is cancelled. | <var>Catch</var> for it, the request is cancelled. | ||
For an example of how you might use an exception in your own code, see this [[InvalidValue class|InvalidValue exception example]]. | |||
The <var>InvalidDeflateData</var> class is available as of <var class="product">[[Sirius Mods]]</var> version 7.9. | The <var>InvalidDeflateData</var> class is available as of <var class="product">[[Sirius Mods]]</var> version 7.9. | ||
| Line 17: | Line 19: | ||
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 | <li>[[Notation conventions for methods]] has information | ||
about the conventions followed. | about the conventions followed. | ||
<li>[[InvalidDeflateData methods syntax | <li>[[InvalidDeflateData methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. | ||
</ul> | </ul> | ||
| Line 27: | Line 29: | ||
This <var>Constructor</var> generates an instance of an <var>[[InvalidDeflateData_class|InvalidDeflateData]]</var> exception. The <var>New</var> method format follows: | This <var>Constructor</var> generates an instance of an <var>[[InvalidDeflateData_class|InvalidDeflateData]]</var> exception. The <var>New</var> method format follows: | ||
===Syntax=== | ===Syntax=== | ||
{{Template:InvalidDeflateData:New syntax}} | {{Template:InvalidDeflateData:New syntax}} | ||
| Line 34: | Line 37: | ||
<tr><th>%invalidDeflateData</th> | <tr><th>%invalidDeflateData</th> | ||
<td>A reference to an instance of an <var>InvalidDeflateData</var> object. </td></tr> | <td>A reference to an instance of an <var>InvalidDeflateData</var> object. </td></tr> | ||
<tr><th><var>[%(InvalidDeflateData):]</var></th> | <tr><th><var>[%(InvalidDeflateData):]</var></th> | ||
<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes| | <td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking an <var>InvalidDeflateData</var> <var>Constructor</var>.</td></tr> | ||
</table> | </table> | ||
===Usage notes=== | ===Usage notes=== | ||
<ul> | <ul> | ||
<li>As described in [[Object variables#Using New or other Constructors| | <li>As described in [[Object variables#Using New or other Constructors|Using New or other Constructors]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>: | ||
<p class="code">%invalid = new | |||
%invalid = %(InvalidDeflateData):new | %invalid = %(InvalidDeflateData):new | ||
| Line 47: | Line 52: | ||
</p> | </p> | ||
</ul> | </ul> | ||
[[Category:System exception classes]] | [[Category:System exception classes]] | ||
Latest revision as of 19:33, 15 March 2016
An InvalidDeflateData exception indicates that during an attempt to extract information from a string, that string was found to not contain a string created by the Deflate function.
To produce an InvalidDeflateData exception yourself, you typically use a User Language Throw statement with an InvalidDeflateData 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 InvalidDeflateData exception:
throw %(invalidDeflateData):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.
For an example of how you might use an exception in your own code, see this InvalidValue exception example.
The InvalidDeflateData class is available as of Sirius Mods version 7.9.
The InvalidDeflateData methods
The following are the available InvalidDeflateData class methods.
| Method | Description |
|---|---|
| New | Create a new InvalidDeflateData 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.
- InvalidDeflateData methods syntax is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new InvalidDeflateData object (InvalidDeflateData class)
[Introduced in Sirius Mods 7.9]
This Constructor generates an instance of an InvalidDeflateData exception. The New method format follows:
Syntax
%invalidDeflateData = [%(InvalidDeflateData):]New
Syntax terms
| %invalidDeflateData | A reference to an instance of an InvalidDeflateData object. |
|---|---|
| [%(InvalidDeflateData):] | The class name in parentheses denotes a Constructor. See Usage notes, below, for more information about invoking an InvalidDeflateData 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 = %(InvalidDeflateData):new %invalid = %invalid:new