InvalidPemData class: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 6: | Line 6: | ||
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: | 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 | <p class="code"> throw %(InvalidPemData):new(line=1, position=13) | ||
</p> | </p> | ||
| Line 24: | Line 24: | ||
</ul> | </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> | <h2>New constructor</h2> | ||
| Line 60: | Line 76: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td>This numeric value is the position in the base64 string where a non-PEM-conforming character was found. | <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> | </td></tr> | ||
<tr><th>invalidPemData</th> | <tr><th>invalidPemData</th> | ||
Revision as of 22:26, 23 April 2012
The InvalidPemData 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 InvalidPemData class has properties that indicate the line and position of the non-conforming data.
A system method that throws this exception is PemToString.
To produce an InvalidPemData exception for yourself, you typically use a User Language Throw statement calling the InvalidPemData New constructor:
throw %(InvalidPemData):new(line=1, position=13)
The methods of the InvalidPemData exception class are described below.
This class is available as of Sirius Mods Version 8.0.
The InvalidPemData methods
The following are the available InvalidPemData class methods.
| Method | Description |
|---|---|
| Line | Line where error encountered |
| New | Create a new InvalidPemData object |
| Position | Position in line where error encountered |
The methods in the class are described in the subsections that follow. In addition:
- "Notation conventions for methods" has information about the conventions followed.
- "InvalidPemData methods syntax" is a single page that contains the syntax diagrams of the methods in the class.
Line property
Line where error encountered (InvalidPemData class)
[Introduced in Sirius Mods 8.0]
This ReadOnly property returns the line in the (expected) PEM data where a non-PEM-conforming character was found.
Syntax
%number = invalidPemData:Line
Syntax terms
| %number | This numeric value is the line in the data being validated where a non-PEM-conforming character was found. |
|---|---|
| invalidPemData | A reference to an instance of an InvalidPemData object. |
New constructor
Create a new InvalidPemData object (InvalidPemData class)
[Introduced in Sirius Mods 8.0]
This method generates an instance of an InvalidPemData exception. The New method format is as follows:
Syntax
%invalidPemData = [%(InvalidPemData):]New( Line= number, Position= number)
Syntax terms
| %invalidPemData | A reference to an instance of a InvalidPemData object. |
|---|---|
| %(InvalidPemData) | The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking a InvalidPemData Constructor. |
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:
%invalidPem = new %invalidPem = %(InvalidPemData):new %invalidPem = %invalidPem:new
Position property
Position in line where error encountered (InvalidPemData class)
[Introduced in Sirius Mods 8.0]
This ReadOnly property returns the position in the (expected) base64-encoded string where a non-PEM-conforming character was found.
Syntax
%number = invalidPemData: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-PEM-conforming character was found. |
|---|---|
| invalidPemData | A reference to an instance of an InvalidPemData object. |