InvalidGZipData class

From m204wiki
Jump to: navigation, search


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.

For an example of how you might use an exception in your own code, see this InvalidValue exception example.

The InvalidGZipData class is available as of Sirius Mods version 7.9.

The InvalidGZipData methods

The following are the available InvalidGZipData class methods.

MethodDescription
NewCreate a new InvalidGZipData object

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

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