InvalidBerData class: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 57: Line 57:
<td>A reference to an instance of a <var>InvalidBerData</var> object.</td></tr>
<td>A reference to an instance of a <var>InvalidBerData</var> object.</td></tr>
<tr><th><var>%(InvalidBerData)</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>InvalidBerData</var> <var>Constructor</var>.</td></tr>
<tr><th><var>%(InvalidBerData)</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>InvalidBerData</var> <var>Constructor</var>.</td></tr>
<tr><th><var>Line</var></th>
<td>This [[Methods#Named parameters|name required]] parameter: <var>Line</var>, specifies the numeric value (<var class="term">number</var>) for the line number to be assigned to the <var>InvalidBerData</var> exception object's <var>Line</var> property when a data error is encountered. </td></tr>
<tr><th><var>Position</var></th>
<tr><th><var>Position</var></th>
<td>This [[Methods#Named parameters|name required]] parameter: <var>Position</var>, specifies the numeric value (<var class="term">number</var>) for the position to be assigned to the <var>InvalidBerData</var> exception object's <var>Position</var> property when a data error is encountered.</table>
<td>This name required parameter: <var>Position</var>, specifies the numeric value (<var class="term">number</var>) for the position to be assigned to the <var>InvalidBerData</var> exception object's <var>Position</var> property when a data error is encountered. </td></tr>
</table>


<h3>Usage notes</h3>
<h3>Usage notes</h3>

Revision as of 01:23, 24 April 2012

Still under construction . . .


The InvalidBerData exception class validates whether the data being processed by the called method conforms to the BER (Basic Encoding Rules) protocol. BER data is base64-encoded binary data; BER rules are a superset of DER (Distinguished Encoding Rules) rules.

The InvalidBerData class has properties that indicate the position and description of the non-conforming data.

An InvalidBerData exception can be thrown by any of the DER-to-XmlDoc methods.

There are currently no standardized error codes.

To produce an InvalidBerData exception for yourself, you typically use a User Language Throw statement calling the InvalidBerData New constructor:

throw %(InvalidBerData):new(position=13, description='BadBad')

The methods of the InvalidBerData exception class are described below.

This class is available as of Sirius Mods Version 8.0.


The InvalidBerData methods

The following are the available InvalidBerData class methods.

MethodDescription
DescriptionDescription of error
NewCreate a new InvalidBerData object
PositionPosition where error encountered

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

Description property

Description of error (InvalidBerData class)

[Introduced in Sirius Mods 8.0]

This ReadOnly property returns a description of the data error.

Syntax

%string = invalidBerData:Description

Syntax terms

%number This numeric value is the line in the data being validated where a non-PEM-conforming character was found.
invalidBerData A reference to an instance of an InvalidBerData object.

New constructor

Create a new InvalidBerData object (InvalidBerData class)

[Introduced in Sirius Mods 8.0]

This method generates an instance of an InvalidBerData exception. The New method format is as follows:

Syntax

%invalidBerData = [%(InvalidBerData):]New( Position= number, - Description= string)

Syntax terms

%invalidBerData A reference to an instance of a InvalidBerData object.
%(InvalidBerData)The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking a InvalidBerData Constructor.
Line This name required parameter: Line, specifies the numeric value (number) for the line number to be assigned to the InvalidBerData exception object's Line property when a data error is encountered.
Position This name required parameter: Position, specifies the numeric value (number) for the position to be assigned to the InvalidBerData exception object's Position property when a data error is encountered.

Usage notes

  • As described in "Using New or other Constructors", New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:

    %invalidBer = new %invalidBer = %(InvalidBerData):new %invalidBer = %invalidBer:new

Position property

Position where error encountered (InvalidBerData class)

[Introduced in Sirius Mods 8.0]

This ReadOnly property returns the position in the (expected) base64-encoded string where a non-BER-conforming character was found.

Syntax

%number = invalidBerData:Position

Syntax terms

%number This numeric value is the position in the base64 string (in the line identified by the value of Line) where a non-BER-conforming character was found.
invalidBerData A reference to an instance of an InvalidBerData object.