InvalidCryptoKey class: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ The <var>InvalidCryptoKey</var> exception class describes an exception associated with finding improper object data, for example, an incorrect length. To produce a...")
 
m (add link to exception example)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
The <var>InvalidCryptoKey</var> exception class describes an exception associated with finding improper object data, for example, an incorrect length.
The <var>InvalidCryptoKey</var> exception class describes an exception associated with finding improper encryption-key data, for example, an incorrect length.
   
   
To produce an <var>InvalidCryptoKey</var> exception yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with an <var>InvalidCryptoData</var> <var>[[New (InvalidCryptoKey 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>InvalidCryptoKey</var> exception:
To produce an <var>InvalidCryptoKey</var> exception yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with an <var>InvalidCryptoKey</var> <var>[[New (InvalidCryptoKey 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>InvalidCryptoKey</var> exception:
<p class="code">throw %(InvalidCryptoKey):new
<p class="code">throw %(InvalidCryptoKey):new
</p>  
</p>  
For an outline of how you might use an exception in a function of your own, see this [[Get (HttpRequest function)#exception-eg|Get method example]].


==The InvalidCryptoKey methods==
==The InvalidCryptoKey methods==

Latest revision as of 18:38, 15 March 2016

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.