InvalidPemData class - Revision history

JAL: add link to exception example

2016-03-15T18:42:08Z

add link to exception example

← Older revision		Revision as of 18:42, 15 March 2016
Line 5:		Line 5:
	A system method that throws this exception is <var>[[PemToString (Stringlist function)\|PemToString]]</var>.		A system method that throws this exception is <var>[[PemToString (Stringlist 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:		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 class="code"> throw %(InvalidPemData):new(line=1, position=13)
	</p>		</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>InvalidPemData</var> exception class are described below.		The methods of the <var>InvalidPemData</var> exception class are described below.

JALWiccan: Automatically generated page update

2014-02-16T00:56:14Z

Automatically generated page update

New page

__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 (Stringlist 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.

==The InvalidPemData methods==
{{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>

==Line property==
{{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.

===Syntax===
{{Template:InvalidPemData:Line 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>invalidPemData</th>
<td>A reference to an instance of an <var>InvalidPemData</var> object.
</td></tr></table>

==New constructor==
{{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:

===Syntax===
{{Template:InvalidPemData:New syntax}}
====Syntax terms====
<table class="syntaxTable">
<tr><th>%invalidPemData</th>
<td>A reference to an instance of a <var>InvalidPemData</var> object.</td></tr>
<tr><th><var class="nobr">%(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>

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

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

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

==Position property==
{{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.

===Syntax===
{{Template:InvalidPemData: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>[[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]]

JAL2 at 18:02, 24 April 2012

2012-04-24T18:02:29Z

← Older revision		Revision as of 18:02, 24 April 2012
Line 3:		Line 3:
	The <var>InvalidPemData</var> class has properties that indicate the line and position of the non-conforming 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>.		A system method that throws this exception is <var>[[PemToString (Stringlist 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:		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:

JAL2 at 01:27, 24 April 2012

2012-04-24T01:27:31Z

← Older revision		Revision as of 01:27, 24 April 2012
Line 53:		Line 53:
	<td>A reference to an instance of a <var>InvalidPemData</var> object.</td></tr>		<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>%(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>		<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>InvalidPemData</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>InvalidPemData</var> exception object's <var>Position</var> property when a data error is encountered.</table>

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

JAL2 at 01:17, 24 April 2012

2012-04-24T01:17:38Z

← Older revision		Revision as of 01:17, 24 April 2012
Line 53:		Line 53:
	<td>A reference to an instance of a <var>InvalidPemData</var> object.</td></tr>		<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>%(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>
	</table>		<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>InvalidPemData</var> exception object's <var>Position</var> property when a data error is encountered.</table>

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

JAL2 at 00:35, 24 April 2012

2012-04-24T00:35:16Z

← Older revision		Revision as of 00:35, 24 April 2012
Line 57:		Line 57:
	<h3>Usage notes</h3>		<h3>Usage notes</h3>
	<ul>		<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		<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		%invalidPem = %(InvalidPemData):new(line=4, position=1)

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

JAL2 at 22:55, 23 April 2012

2012-04-23T22:55:22Z

← Older revision		Revision as of 22:55, 23 April 2012
Line 1:		Line 1:
	~~'''''Still under construction . . .'''''~~

	__NOTOC__		__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> 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.

JAL2 at 22:55, 23 April 2012

2012-04-23T22:55:01Z

← Older revision		Revision as of 22:55, 23 April 2012
Line 1:		Line 1:
			'''''Still under construction . . .'''''

	__NOTOC__		__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> 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.

JAL2 at 22:26, 23 April 2012

2012-04-23T22:26:32Z

← Older revision		Revision as of 22:26, 23 April 2012
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>

JAL2 at 22:02, 23 April 2012

2012-04-23T22:02:56Z

@@ Line 48: / Line 48: @@
 </p>
 </ul>
 [[Category:System exception classes]]