PKCSError class

The PKCSError exception class describes an exception associated with finding data that does not conform to the Public-Key Cryptography Standards (PKCS). See, for example, PKCS #1 for more information about what the standards affect.

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

throw %(PKCSError):new

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

The PKCSErrormethods

The following are the available PKCSError class methods.

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

Code function

Code method (PKCSError class)

Syntax

%number = pKCSError:Code

Syntax terms

%number	This numeric variable is one of the return codes that can be reported by the AppendCertificateRequest or AppendSignedCertificate methods.
pkcsError	An instance of a PKCSError object.

Description function

Description method (PKCSError class)

Syntax

%string = pKCSError:Description

Syntax terms

%string	A string to contain the description of the exception.
pkcsError	An instance of a PKCSError object.

New constructor

Create a new PKCSError object (PKCSError class)

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

Syntax

%pKCSError = [%(PKCSError):]New( Code= number, Description= string)

Syntax terms

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