InvalidGZipData class: Difference between revisions
m (Created page with "<!-- InvalidGZipData class --> __NOTOC__ An <var>InvalidGZipData</var> exception indicates that during an attempt to extract information from a string, that string was found to n...") |
|||
Line 34: | Line 34: | ||
<tr><th>%invalidGZipData</th> | <tr><th>%invalidGZipData</th> | ||
<td>A reference to an instance of an <var>InvalidGZipData</var> object. </td></tr> | <td>A reference to an instance of an <var>InvalidGZipData</var> object. </td></tr> | ||
<tr><th><var>[%(InvalidGZipData)]</var></th> | <tr><th><var>[%(InvalidGZipData):]</var></th> | ||
<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>InvalidGZipData</var> <var>Constructor</var>.</td></tr> | <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>InvalidGZipData</var> <var>Constructor</var>.</td></tr> | ||
</table> | </table> |
Revision as of 17:51, 7 August 2012
An InvalidGZipData exception indicates that during an attempt to extract information from a string, that string was found to not contain the valid result of a GZIP operation.
To produce an InvalidGZipData exception yourself, you typically use a User Language Throw statement with an InvalidGZipData 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 InvalidGZipData exception:
throw %(invalidGZipData):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 InvalidGZipData class is available as of version 7.9.
The InvalidGZipData methods
The following are the available InvalidGZipData class methods.
Method | Description |
---|---|
New | Create a new InvalidGZipData 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.
- "InvalidGZipData methods syntax" is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new InvalidGZipData object (InvalidGZipData class)
[Introduced in Sirius Mods 7.9]
This Constructor generates an instance of an InvalidGZipData exception. The New method format follows:
Syntax
%invalidGZipData = [%(InvalidGZipData):]New
Syntax terms
%invalidGZipData | A reference to an instance of an InvalidGZipData object. |
---|---|
[%(InvalidGZipData):] | The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking an InvalidGZipData 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 = %(InvalidGZipData):new %invalid = %invalid:new