InvalidCryptoKey class
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.
Method | Description |
---|---|
New | Create a new InvalidCryptoKey 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.
- InvalidCryptoKey methods syntax is a single page that contains the syntax diagrams of all the methods in the class.
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. |