InvalidCryptoKey class

From m204wiki
Revision as of 18:38, 15 March 2016 by JAL (talk | contribs) (add link to exception example)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The InvalidCryptoKey exception class describes an exception associated with finding improper encryption-key data, for example, an incorrect length.

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

throw %(InvalidCryptoKey):new

For an outline of how you might use an exception in a function of your own, see this Get method example.

The InvalidCryptoKey methods

The following are the available InvalidCryptoKey class methods.

MethodDescription
NewCreate a new InvalidCryptoKey object

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

New constructor

Create a new InvalidCryptoKey object (InvalidCryptoKey class)

This Constructor generates an instance of an InvalidCryptoKey exception. As shown below, the New method takes no arguments.

Syntax

%invalidCryptoKey = [%(InvalidCryptoKey):]New

Syntax terms

%invalidCryptoKey A reference to an instance of an InvalidCryptoKey object.
[%(InvalidCryptoKey):]The class name in parentheses denotes a Constructor.