View source for InvalidBerData class

__NOTOC__
The <var>InvalidBerData</var> 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 <var>InvalidBerData</var> class has properties that indicate the position and description of the non-conforming data. There are currently no standardized error codes.
 
An <var>InvalidBerData</var> exception can be thrown by any of the [[Release notes for Sirius Mods V8.0#DER2Xml|DER-to-XmlDoc]] methods.

To produce an <var>InvalidBerData</var> exception for yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement calling the <var>InvalidBerData</var> <var>[[New_(InvalidBerData_constructor)|New]]</var> constructor:
<p class="code"> throw %(InvalidBerData):new(position=13, description='did not get expected tag')
</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 methods of the <var>InvalidBerData</var> exception class are described below.
  
This class is available as of <var class="product">[[Sirius Mods]]</var> Version 8.0.


==The InvalidBerData methods==
{{Template:List of InvalidBerData methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information
about the conventions followed. 
<li>[[InvalidBerData methods syntax]] is a single page that contains the syntax diagrams of the methods in the class.
</ul>

==Description property==
{{Template:InvalidBerData:Description subtitle}}

This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns a description of the data error.
===Syntax===
{{Template:InvalidBerData:Description syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%number</th>
<td>This numeric value is the line in the data being validated where a non-PEM-conforming character was found.
</td></tr>
<tr><th>invalidBerData</th>
<td>A reference to an instance of an <var>InvalidBerData</var> object.
</td></tr></table>

==New constructor==
{{Template:InvalidBerData:New subtitle}}

This method generates an instance of an <var>[[InvalidBerData_class|InvalidBerData]]</var> exception. The <var>New</var> method format is as follows:

===Syntax===
{{Template:InvalidBerData:New syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%invalidBerData</th>
<td>A reference to an instance of a <var>InvalidBerData</var> object.</td></tr>

<tr><th><var class="nobr">%(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>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. </td></tr>

<tr><th><var>Description</var></th>
<td>This name required parameter: <var>Description</var>, is the string, containing a brief description of the exception, that is assigned to the <var>InvalidBerData</var> exception object's <var>Description</var> property when a data error is encountered. </td></tr>
</table>

===Usage notes===
<ul>
<li>As described in [[Object variables#Using New or other Constructors|Using New or other Constructors]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:<p class="code">%invalidBer = new(position=1, description='unexpected junk after end of BER data')

%invalidBer = %(InvalidBerData):new(position=1, description='did not get expected tag')

%invalidBer = %invalidBer:new(position=1, description='unexpected junk after end of BER data')
</p>
</ul>

==Position property==
{{Template:InvalidBerData:Position subtitle}}

This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns the position in the (expected) base64-encoded string where a non-BER-conforming character was found.

===Syntax===
{{Template:InvalidBerData:Position syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%number</th>
<td>This numeric value is the position in the base64 string (in the line identified by the value of <var>[[InvalidBerData class#Line property|Line]]</var>) where a non-BER-conforming character was found.
</td></tr>
<tr><th>invalidBerData</th>
<td>A reference to an instance of an <var>InvalidBerData</var> object.
</td></tr></table>

[[Category:System exception classes]]