UnsupportedCrypto class: Difference between revisions
m (add comment) |
m (add detail) |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
The <var>UnsupportedCrypto</var> exception class describes an exception associated with finding a request for a cipher that is not supported by the hardware. | The <var>UnsupportedCrypto</var> exception class describes an exception associated with finding a request for a cipher that is not supported by the hardware. This is purely a machine configuration issue: if the machine involved is configured to support the cipher required by the method, no exception is thrown. | ||
To produce an <var>UnsupportedCrypto</var> exception yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with an <var>UnsupportedCrypto</var> <var>[[New (UnsupportedCrypto constructor)|New]]</var> 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 <var>UnsupportedCrypto</var> exception: | To produce an <var>UnsupportedCrypto</var> exception yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with an <var>UnsupportedCrypto</var> <var>[[New (UnsupportedCrypto constructor)|New]]</var> 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 <var>UnsupportedCrypto</var> exception: |
Latest revision as of 19:59, 10 March 2016
The UnsupportedCrypto exception class describes an exception associated with finding a request for a cipher that is not supported by the hardware. This is purely a machine configuration issue: if the machine involved is configured to support the cipher required by the method, no exception is thrown.
To produce an UnsupportedCrypto exception yourself, you typically use a SOUL Throw statement with an UnsupportedCrypto 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 UnsupportedCrypto exception:
throw %(UnsupportedCrypto):new
The UnsupportedCrypto methods
The following are the available UnsupportedCrypto class methods.
Method | Description |
---|---|
New | Create a new UnsupportedCrypto 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.
- UnsupportedCrypto methods syntax is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new UnsupportedCrypto object (UnsupportedCrypto class)
This Constructor generates an instance of an UnsupportedCrypto exception. As shown below, the New method takes no arguments.
Syntax
%unsupportedCrypto = [%(UnsupportedCrypto):]New
Syntax terms
%unsupportedCrypto | A reference to an instance of an UnsupportedCrypto object. |
---|---|
[%(UnsupportedCrypto):] | The class name in parentheses denotes a Constructor. |