View source for InvalidPemData class

__NOTOC__
The <var>InvalidPemData</var> exception class validates whether the data being processed by the called method conforms to the PEM (Privacy Enhanced Mail) protocol. PEM data is base64-encoded binary data.
The <var>InvalidPemData</var> class has properties that indicate the line and position of the non-conforming data.
 
A system method that throws this exception is <var>[[PemToString (String function)|PemToString]]</var>.

To produce an <var>InvalidPemData</var> exception for yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement calling the <var>InvalidPemData</var> <var>[[New_(InvalidPemData_constructor)|New]]</var> constructor:
<p class="code"> throw %(InvalidPemData):new(line=1, position=13)
</p>
 
The methods of the <var>InvalidPemData</var> exception class are described below.
  
This class is available as of <var class="product">[[Sirius Mods]]</var> Version 8.0.


<h2>The InvalidPemData methods</h2>
{{Template:List of InvalidPemData methods}}

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

<h2>Line property</h2>
{{Template:InvalidPemData:Line subtitle}}

This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns the line in the (expected) PEM data where a non-PEM-conforming character was found.

<h3>Syntax</h3>
{{Template:InvalidPemData:Line syntax}}

<h4>Syntax terms</h4>
<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>invalidPemData</th>
<td>A reference to an instance of an <var>InvalidPemData</var> object.
</td></tr></table>

<h2>New constructor</h2>
{{Template:InvalidPemData:New subtitle}}

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

<h3>Syntax</h3>
{{Template:InvalidPemData:New syntax}}
<h4>Syntax terms</h4>
<table class="syntaxTable">
<tr><th>%invalidPemData</th>
<td>A reference to an instance of a <var>InvalidPemData</var> object.</td></tr>
<tr><th><var>%(InvalidPemData)</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>InvalidPemData</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>
<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>InvalidPemData</var> exception object's <var>Position</var> property when a data error is encountered.</table>

<h3>Usage notes</h3>
<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">%invalidPem = new(line=4, position=1)

%invalidPem = %(InvalidPemData):new(line=4, position=1)

%invalidPem = %invalidPem:new(line=4, position=1)
</p>
</ul>

<h2>Position property</h2>
{{Template:InvalidPemData:Position subtitle}}

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

<h3>Syntax</h3>
{{Template:InvalidPemData:Position syntax}}

<h4>Syntax terms</h4>
<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>[[InvalidPemData class#Line property|Line]]</var>) where a non-PEM-conforming character was found.
</td></tr>
<tr><th>invalidPemData</th>
<td>A reference to an instance of an <var>InvalidPemData</var> object.
</td></tr></table>

[[Category:System exception classes]]