InvalidZipData class

From m204wiki
Jump to navigation Jump to search

An InvalidZipData exception indicates that during an attempt to extract information from a string, that string was found to not contain the valid result of a ZIP operation.

To produce an InvalidZipData exception yourself, you typically use a SOUL Throw statement with an InvalidZipData 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 InvalidZipData exception:

throw %(invalidZipData):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 InvalidZipData methods

The following are the available InvalidZipData class methods.

NewCreate a new InvalidZipData object

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

New constructor

Create a new InvalidZipData object (InvalidZipData class)

[Introduced in Sirius Mods 7.9]

This Constructor generates an instance of an InvalidZipData exception. The New method format follows:


%invalidZipData = [%(InvalidZipData):]New

Syntax terms

%invalidZipData A reference to an instance of an InvalidZipData object.
[%(InvalidZipData):] The class name in parentheses denotes a Constructor. See Usage notes, below, for more information about invoking an InvalidZipData 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 = %(InvalidZipData):new %invalid = %invalid:new