XmlParseError class - Revision history

JAL: /* XmlParseErrorReason enumeration */

2014-07-23T19:20:44Z

XmlParseErrorReason enumeration

← Older revision		Revision as of 19:20, 23 July 2014
Line 134:		Line 134:
	====XmlParseErrorReason enumeration====		====XmlParseErrorReason enumeration====
	An <var>XmlParseErrorReason</var> [[Enumerations\|enumeration]] may have one of the following values, each of which is demonstrated in the [[#Example\|examples]] below.		An <var>XmlParseErrorReason</var> [[Enumerations\|enumeration]] may have one of the following values, each of which is demonstrated in the [[#Example\|examples]] below.
	<table>		<table class="thJustBold">
	<tr><th>InvalidUnicodeCharacter		<tr><th>InvalidUnicodeCharacter
	</th><td>The Unicode input contains an invalid character.</td></tr>		</th><td>The Unicode input contains an invalid character.</td></tr>

JAL at 21:40, 30 June 2014

2014-06-30T21:40:02Z

← Older revision		Revision as of 21:40, 30 June 2014
Line 9:		Line 9:
	The methods in the class are described in the subsections that follow. In addition:		The methods in the class are described in the subsections that follow. In addition:
	<ul>		<ul>
	<li>[[Notation conventions for methods~~\|"Notation conventions for methods"~~]] has information		<li>[[Notation conventions for methods]] has information
	about the conventions followed.		about the conventions followed.
	<li>[[XmlParseError methods syntax~~\|"XmlParseError methods syntax"~~]] is a single page that contains the syntax diagrams of all the methods in the class.		<li>[[XmlParseError methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class.
	</ul>		</ul>

Line 159:		Line 159:
	===Usage notes===		===Usage notes===
	<ul>		<ul>
	<li>As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods\|"Common enumeration methods"]].		<li>As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods\|Common enumeration methods]].
	</ul>		</ul>

JAL at 22:16, 28 November 2012

2012-11-28T22:16:35Z

← Older revision		Revision as of 22:16, 28 November 2012
Line 1:		Line 1:
	~~<!-- XmlParseError class -->~~
	__NOTOC__		__NOTOC__
	The <var>XmlParseError</var> exception class catches parsing errors (including syntax, translation, and encoding errors) thrown by the deserialization methods: <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> and <var>[[WebReceive_(XmlDoc_function)\|WebReceive]]</var> of the <var class="product">Janus SOAP</var> <var>[[XmlDoc API]]</var>, and the <var>[[ParseXml (HttpResponse function)\|ParseXml]]</var> method of the <var>[[HttpResponse class\|HttpResponse ]]</var> class.		The <var>XmlParseError</var> exception class catches parsing errors (including syntax, translation, and encoding errors) thrown by the deserialization methods: <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> and <var>[[WebReceive_(XmlDoc_function)\|WebReceive]]</var> of the <var class="product">Janus SOAP</var> <var>[[XmlDoc API]]</var>, and the <var>[[ParseXml (HttpResponse function)\|ParseXml]]</var> method of the <var>[[HttpResponse class\|HttpResponse ]]</var> class.

JAL at 00:25, 22 November 2012

2012-11-22T00:25:17Z

New page

__NOTOC__
The <var>XmlParseError</var> exception class catches parsing errors (including syntax, translation, and encoding errors) thrown by the deserialization methods: <var>[[LoadXml_(XmlDoc/XmlNode_function)|LoadXml]]</var> and <var>[[WebReceive_(XmlDoc_function)|WebReceive]]</var> of the <var class="product">Janus SOAP</var> <var>[[XmlDoc API]]</var>, and the <var>[[ParseXml (HttpResponse function)|ParseXml]]</var> method of the <var>[[HttpResponse class|HttpResponse ]]</var> class.

This class is available as of <var class="product">[[Sirius Mods]]</var> Version 7.6.

==The XmlParseError methods==
{{Template:List of XmlParseError 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>[[XmlParseError methods syntax|"XmlParseError methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
</ul>

==CharacterPosition property==
{{Template:XmlParseError:CharacterPosition subtitle}}

This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns a number that indicates the position within the input character stream (starting with 1) at or before which the error was detected.

===Syntax===
{{Template:XmlParseError:CharacterPosition syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%number</th>
<td>The position at or before which the error was detected.</td></tr>

<tr><th>xmlParsError</th>
<td>A reference to an instance of an <var>[[XmlParseError_class|XmlParseError]]</var> object.</td></tr>
</table>

===Usage notes===
<ul>
<li>The number of bytes that constitute a character depends on the type of string that causes the exception:
<ul>
<li>If EBCDIC, one byte corresponds to one character.
<li>If [[Unicode|Unicode]], two bytes correspond to one character.
<li>If UTF-16, two bytes correspond to one character.
<li>If UTF-8, the relationship between bytes and characters is variable, depending on the code points.
</ul>
</ul>

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

This <var>ReadOnly</var> property returns a string that contains a brief description of the exception.

===Syntax===
{{Template:XmlParseError:Description syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%string</th>
<td>A string to receive the description of the exception.</td></tr>

<tr><th>xmlParsError</th>
<td>A reference to an instance of a <var>[[XmlParseError_class|XmlParseError]]</var> object.</td></tr>
</table>

==InputHexValue property==
{{Template:XmlParseError:InputHexValue subtitle}}

This <var>ReadOnly</var> property returns a string that contains the hexadecimal representation of the bytes that caused the exception to be thrown.

<var>InputHexvalue</var> returns a value for all [[Reason (XmlParseError property)|reasons]] except <var>SyntaxError</var>.

===Syntax===
{{Template:XmlParseError:InputHexValue syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%string</th>
<td>A string to receive the hexadecimal value of the bytes that caused the exception to be thrown.</td></tr>

<tr><th>xmlParsError</th>
<td>A reference to an instance of a <var>[[XmlParseError_class|XmlParseError]]</var> object.</td></tr>
</table>

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

This <var>Constructor</var> generates an instance of an <var>XmlParseError</var> exception. As shown in the syntax that follows, the <var>New</var> method arguments set the values of the class properties that have the corresponding names.

Each argument to <var>New</var> sets the value of the corresponding property of the newly constructed <var>XmlParseError</var> object.

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

====Syntax terms====
<table class="syntaxTable">
<tr><th>xmlParsError</th>
<td>A reference to an instance of a <var>[[XmlParseError_class|XmlParseError]]</var> object.</td></tr>

<tr><th><var>[%(XmlParseError):]</var></th>
<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>.</td></tr>

<tr><th><var>Reason</var></th>
<td>This [[Methods#Named parameters|name required]] parameter specifies the value to be assigned to the exception object's <var>[[Reason_(XmlParseError_property)|Reason]]</var> property.
<var>Reason</var> settings are <var>[[#XmlParseErrorReason enumeration|XmlParseErrorReason]]</var> enumeration values.
The <var>Reason</var> parameter is '''not''' optional.</td></tr>

<tr><th><var>CharacterPosition</var></th>
<td>This optional, but name required, parameter specifies the numeric value (<var class="term">number</var>) to be assigned to the object's <var>[[CharacterPosition_(XmlParseError_property)|CharacterPosition]]</var> property. Its default value is 0.</td></tr>

<tr><th><var>Description</var></th>
<td>This optional, but name required, parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[Description_(XmlParseError_property)|Description]]</var> property. Its default value is a null string.</td></tr>

<tr><th><var>InputHexValue</var></th>
<td>This optional, but name required, parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[InputHexValue_(XmlParseError_property)|InputHexValue]]</var> property. Its default value is a null string.</td></tr>
</table>

==Reason property==
{{Template:XmlParseError:Reason subtitle}}

This <var>ReadOnly</var> property returns an <var>XmlParseErrorReason</var> enumeration value that describes the error that caused the <var>[[XmlParseError_class|XmlParseError]]</var> exception.

===Syntax===
{{Template:XmlParseError:Reason syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%xmlParseErrorReason</th>
<td>This <var>XmlParseErrorReason</var> enumeration value (see below) describes the parsing error.</td></tr>

<tr><th>xmlParsError</th>
<td>A reference to an instance of a <var>[[XmlParseError_class|XmlParseError]]</var> object.</td></tr>
</table>

====XmlParseErrorReason enumeration====
An <var>XmlParseErrorReason</var> [[Enumerations|enumeration]] may have one of the following values, each of which is demonstrated in the [[#Example|examples]] below.
<table>
<tr><th>InvalidUnicodeCharacter
</th><td>The Unicode input contains an invalid character.</td></tr>

<tr><th>InvalidUTF8Encoding
</th><td>The input UTF8 stream is invalid.</td></tr>

<tr><th>InvalidUTF16Encoding
</th><td>The input UTF16 stream is invalid.</td></tr>

<tr><th>SyntaxError
</th><td>A violation of the syntax of an XML document.</td></tr>

<tr><th>UntranslatableEBCDIC
</th><td>The EBCDIC input contains a character that is not translatable to Unicode.</td></tr>

<tr><th>UntranslatableISOn
</th><td>The ISO-8859-n input contains a character that is not translatable to Unicode.</td></tr>

<tr><th>UntranslatableUnicode
</th><td>The Unicode input contains a character that is not translatable to EBCDIC. This exception can be avoided using the <var>AllowUntranslatable</var> option of the deserialization method.</td></tr>
</table>

===Usage notes===
<ul>
<li>As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods|"Common enumeration methods"]].
</ul>

===Example===
The following template is used to apply the <var>[[LoadXml_(XmlDoc/XmlNode_function)|LoadXml]]</var> deserialization method to a series of test <code>input-string</code> values to demonstrate the <var>XmlParseError</var> exception output:
<p class="code">[[Exceptions#Try and Catch|try]]
[[PrintText statement|printText]] {~}: {%d:LoadXml(''input-string'')}
[[Exceptions#Try and Catch|catch]] XmlParseError to %err
print ' '
print 'Error Reason:' And %err:Reason:ToString
print 'Error Description:' And %err:Description
print 'Error Character Position:' And %err:CharacterPosition
print 'Error Input Hex Value:' And %err:InputHexValue
print ' - - -'
end try
</p>
<ul>
<li>When called with:
<p class="code">'''%d:LoadXml('<a>'):'''
</p>
The results are:
<p class="output">Error Reason: SyntaxError
Error Description: XML doc parse error: missing ETag for top
level element near or before position 4 (end of input)
Error Character Position: 4
Error Input Hex Value:
- - -
</p>

<li>When called with:
<p class="code">'''%d:LoadXml('<' With 'FF':X With '>')'''
</p>
The results are:
<p class="output">Error Reason: UntranslatableEBCDIC
Error Description: XML doc parse error: EBCDIC character not
translatable to Unicode near or before position 3
Error Character Position: 3
Error Input Hex Value: FF
- - -
</p>

<li>When called with:
<p class="code">'''%d:LoadXml('<a>&#x2122;</a>':[[U (String function)|U]])'''
</p>
The results are:
<p class="output">Error Reason: UntranslatableUnicode
Error Description: XML doc parse error: invalid Unicode
character - not translatable to EBCDIC near or
before position 5
Error Character Position: 5
Error Input Hex Value: 2122
- - -
</p>

<li>When called with:
<p class="code">'''%d:LoadXml('FEFF003C33':[[X (String function)|X]])'''
</p>
The results are:
<p class="output">Error Reason: InvalidUTF16Encoding
Error Description: XML doc parse error: expecting additional
byte of UTF-16 encoding near or before position 2
(end of input)
Error Character Position: 2
Error Input Hex Value: 33
- - -
</p>

<li>When called with:
<p class="code">'''%d:LoadXml('FEFFD800':X)'''
</p>
The results are:
<p class="output">Error Reason: InvalidUnicodeCharacter
Error Description: XML doc parse error: surrogate point in
UTF-16 input near or before position 1
Error Character Position: 1
Error Input Hex Value: D800
- - -
</p>

<li>When called with:
<p class="code">'''%d:LoadXml('C181':X)'''
</p>
The results are:
<p class="output">Error Reason: InvalidUTF8Encoding
Error Description: XML doc parse error: byte 1 of 2 too
low in UTF-8 encoding near or before position 2
Error Character Position: 2
Error Input Hex Value: C181
- - -
</p>

<li>When called with:
<p class="code">'''%d:LoadXml('FF818256':X)'''
</p>
The results are:
<p class="output">Error Reason: InvalidUTF8Encoding
Error Description: XML doc parse error: attempt to use
4-byte UTF-8 encoding of surrogate point near or
before position 2
Error Character Position: 2
Error Input Hex Value: FF
- - -
</p>

<li>When called with:
<p class="code">'''%d:LoadXml('EDA080':X)'''
</p>
The results are:
<p class="output">Error Reason: InvalidUnicodeCharacter
Error Description: XML doc parse error: invalid Unicode
character (surrogate range) near or before position 2
Error Character Position: 2
Error Input Hex Value: EDA080
- - -
</p>
</ul>

[[Category:System exception classes]]

JAL2 at 18:42, 7 August 2012

2012-08-07T18:42:27Z

← Older revision		Revision as of 18:42, 7 August 2012
Line 82:		Line 82:


	~~<h2>~~New constructor~~</h2>~~		==New constructor==
	{{Template:XmlParseError:New subtitle}}		{{Template:XmlParseError:New subtitle}}

Line 90:		Line 90:
	<h3>Syntax</h3>		<h3>Syntax</h3>
	{{Template:XmlParseError:New syntax}}		{{Template:XmlParseError:New syntax}}

	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>
	<table class="syntaxTable">		<table class="syntaxTable">
Line 95:		Line 96:
	<td>A reference to an instance of a <var>[[XmlParseError_class\|XmlParseError]]</var> object.		<td>A reference to an instance of a <var>[[XmlParseError_class\|XmlParseError]]</var> object.
	</td></tr>		</td></tr>
	<tr><th><var>%(XmlParseError)</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>.</td></tr>
			<tr><th><var>[%(XmlParseError):]</var></th>
			<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>.</td></tr>

	<tr><th><var>Reason</var></th>		<tr><th><var>Reason</var></th>
	<td>This [[Methods#Named parameters\|name required]] parameter specifies the value to be assigned to the exception object's <var>[[Reason_(XmlParseError_property)\|Reason]]</var> property.		<td>This [[Methods#Named parameters\|name required]] parameter specifies the value to be assigned to the exception object's <var>[[Reason_(XmlParseError_property)\|Reason]]</var> property.
Line 101:		Line 105:
	The <var>Reason</var> parameter is '''not''' optional.		The <var>Reason</var> parameter is '''not''' optional.
	</td></tr>		</td></tr>

	<tr><th><var>CharacterPosition</var></th>		<tr><th><var>CharacterPosition</var></th>
	<td>This optional, but name required, parameter specifies the numeric value (<var class="term">number</var>) to be assigned to the object's <var>[[CharacterPosition_(XmlParseError_property)\|CharacterPosition]]</var> property. Its default value is 0.		<td>This optional, but name required, parameter specifies the numeric value (<var class="term">number</var>) to be assigned to the object's <var>[[CharacterPosition_(XmlParseError_property)\|CharacterPosition]]</var> property. Its default value is 0.
	</td></tr>		</td></tr>

	<tr><th><var>Description</var></th>		<tr><th><var>Description</var></th>
	<td>This optional, but name required, parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[Description_(XmlParseError_property)\|Description]]</var> property. Its default value is a null string.		<td>This optional, but name required, parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[Description_(XmlParseError_property)\|Description]]</var> property. Its default value is a null string.
	</td></tr>		</td></tr>

	<tr><th><var>InputHexValue</var></th>		<tr><th><var>InputHexValue</var></th>
	<td>This optional, but name required, parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[InputHexValue_(XmlParseError_property)\|InputHexValue]]</var> property. Its default value is a null string.		<td>This optional, but name required, parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[InputHexValue_(XmlParseError_property)\|InputHexValue]]</var> property. Its default value is a null string.
Line 161:		Line 168:
	<h3>Example</h3>		<h3>Example</h3>
	The following template is used to apply the <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> deserialization method to a series of test ''input-string'' values to demonstrate the <var>XmlParseError</var> exception output:		The following template is used to apply the <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> deserialization method to a series of test ''input-string'' values to demonstrate the <var>XmlParseError</var> exception output:
	<p class="code"> [[try]]		<p class="code"> [[Exceptions#Try and Catch\|try]]
	[[PrintText statement\|printText]] {~}: {%d:LoadXml(''input-string'')}		[[PrintText statement\|printText]] {~}: {%d:LoadXml(''input-string'')}
	[[catch]] XmlParseError to %err		[[Exceptions#Try and Catch\|catch]] XmlParseError to %err
	print ' '		print ' '
	print 'Error Reason:' And %err:Reason:ToString		print 'Error Reason:' And %err:Reason:ToString

JAL2 at 21:35, 16 August 2011

2011-08-16T21:35:39Z

← Older revision		Revision as of 21:35, 16 August 2011
Line 130:		Line 130:

	<h4>XmlParseErrorReason enumeration</h4>		<h4>XmlParseErrorReason enumeration</h4>
	An <var>XmlParseErrorReason</var> enumeration may have one of the following values, each of which is demonstrated in the [[#Example\|examples]] below.		An <var>XmlParseErrorReason</var> [[Enumerations\|enumeration]] may have one of the following values, each of which is demonstrated in the [[#Example\|examples]] below.
	<table>		<table>
	<tr><th>InvalidUnicodeCharacter		<tr><th>InvalidUnicodeCharacter
Line 151:		Line 151:
	</td></tr>		</td></tr>
	<tr><th>UntranslatableUnicode		<tr><th>UntranslatableUnicode
	</th><td>The Unicode input contains a character that is not translatable to EBCDIC. This exception can be avoided using the <~~code~~>AllowUntranslatable</~~code~~> option of the deserialization method.		</th><td>The Unicode input contains a character that is not translatable to EBCDIC. This exception can be avoided using the <var>AllowUntranslatable</var> option of the deserialization method.
	</td></tr></table>		</td></tr></table>

			<h3>Usage notes</h3>
			<ul>
			<li>As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods\|"Common enumeration methods"]].
			</ul>

	<h3>Example</h3>		<h3>Example</h3>

JAL2 at 21:13, 27 July 2011

2011-07-27T21:13:58Z

← Older revision		Revision as of 21:13, 27 July 2011
Line 85:		Line 85:
	{{Template:XmlParseError:New subtitle}}		{{Template:XmlParseError:New subtitle}}

	This ~~constructor~~ generates an instance of an <var>XmlParseError</var> exception. As shown in the syntax that follows, the <var>New</var> method arguments set the values of the class properties that have the corresponding names.		This <var>Constructor</var> generates an instance of an <var>XmlParseError</var> exception. As shown in the syntax that follows, the <var>New</var> method arguments set the values of the class properties that have the corresponding names.

	Each argument to <var>New</var> sets the value of the corresponding property of the newly constructed <var>XmlParseError</var> object.		Each argument to <var>New</var> sets the value of the corresponding property of the newly constructed <var>XmlParseError</var> object.
Line 95:		Line 95:
	<td>A reference to an instance of a <var>[[XmlParseError_class\|XmlParseError]]</var> object.		<td>A reference to an instance of a <var>[[XmlParseError_class\|XmlParseError]]</var> object.
	</td></tr>		</td></tr>
	<tr><th><var>%(XmlParseError)</var></th><td>The class name in parentheses denotes a ~~shared method~~.</td></tr>		<tr><th><var>%(XmlParseError)</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>.</td></tr>
	<tr><th><var>Reason</var></th>		<tr><th><var>Reason</var></th>
	<td>This [[Methods#Named parameters\|name required]] parameter specifies the value to be assigned to the exception object's <var>[[Reason_(XmlParseError_property)\|Reason]]</var> property.		<td>This [[Methods#Named parameters\|name required]] parameter specifies the value to be assigned to the exception object's <var>[[Reason_(XmlParseError_property)\|Reason]]</var> property.

JAL2 at 22:55, 17 May 2011

2011-05-17T22:55:58Z

Show changes

JAL2 at 22:51, 17 May 2011

2011-05-17T22:51:34Z

← Older revision		Revision as of 22:51, 17 May 2011
Line 21:		Line 21:
	This <var>[[Classes and Objects#readWrite\|ReadOnly]]</var> property returns a number that indicates the position within the input character stream (starting with 1) at or before which the error was detected.		This <var>[[Classes and Objects#readWrite\|ReadOnly]]</var> property returns a number that indicates the position within the input character stream (starting with 1) at or before which the error was detected.

	<h4>Syntax</h4>		<h3>Syntax</h3>
	{{Template:XmlParseError:CharacterPosition syntax}}		{{Template:XmlParseError:CharacterPosition syntax}}
	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>
Line 32:		Line 32:
	</table>		</table>

	<h4>Usage notes</h4>		<h3>Usage notes</h3>
	<ul>		<ul>
	<li>The number of bytes that constitute a character depends on the type of string that causes the exception:		<li>The number of bytes that constitute a character depends on the type of string that causes the exception:
Line 50:		Line 50:
	This <var>[[Classes and Objects#readWrite\|ReadOnly]]</var> property returns a string that contains a brief description of the exception.		This <var>[[Classes and Objects#readWrite\|ReadOnly]]</var> property returns a string that contains a brief description of the exception.

	<h4>Syntax</h4>		<h3>Syntax</h3>
	{{Template:XmlParseError:Description syntax}}		{{Template:XmlParseError:Description syntax}}
	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>
Line 70:		Line 70:
	<var>InputHexvalue</var> returns a value for all [[Reason (XmlParseError property)\|reasons]] except <var>SyntaxError</var>.		<var>InputHexvalue</var> returns a value for all [[Reason (XmlParseError property)\|reasons]] except <var>SyntaxError</var>.

	<h4>Syntax</h4>		<h3>Syntax</h3>
	{{Template:XmlParseError:InputHexValue syntax}}		{{Template:XmlParseError:InputHexValue syntax}}
	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>
Line 88:		Line 88:

	Each argument to <var>New</var> sets the value of the corresponding property of the newly constructed <var>XmlParseError</var> object.		Each argument to <var>New</var> sets the value of the corresponding property of the newly constructed <var>XmlParseError</var> object.
	<h4>Syntax</h4>		<h3>Syntax</h3>
	{{Template:XmlParseError:New syntax}}		{{Template:XmlParseError:New syntax}}
	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>
Line 98:		Line 98:
	<tr><th><var>Reason</var></th>		<tr><th><var>Reason</var></th>
	<td>This [[Methods#Named parameters\|name required]] parameter specifies the value to be assigned to the exception object's <var>[[Reason_(XmlParseError_property)\|Reason]]</var> property.		<td>This [[Methods#Named parameters\|name required]] parameter specifies the value to be assigned to the exception object's <var>[[Reason_(XmlParseError_property)\|Reason]]</var> property.
	<var>Reason</var> settings are <var>XmlParseErrorReason</var> enumeration values~~, which are described below in [[Reason (XmlParseError property)#Syntax terms\|"Reason property"]]~~.		<var>Reason</var> settings are <var>[[#XmlParseErrorReason enumeration\|XmlParseErrorReason]]</var> enumeration values.
	The <var>Reason</var> parameter is '''not''' optional.		The <var>Reason</var> parameter is '''not''' optional.
	</td></tr>		</td></tr>
Line 117:		Line 117:
	This <var>ReadOnly</var> property returns an <var>XmlParseErrorReason</var> enumeration value that describes the error that caused the <var>[[XmlParseError_class\|XmlParseError]]</var> exception.		This <var>ReadOnly</var> property returns an <var>XmlParseErrorReason</var> enumeration value that describes the error that caused the <var>[[XmlParseError_class\|XmlParseError]]</var> exception.

	<h4>Syntax</h4>		<h3>Syntax</h3>
	{{Template:XmlParseError:Reason syntax}}		{{Template:XmlParseError:Reason syntax}}
	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%reason</th>		<tr><th>%reason</th>
	<td>This <var>XmlParseErrorReason</var> enumeration value describes the parsing error.		<td>This <var>XmlParseErrorReason</var> enumeration value (see below) describes the parsing error.
	</td></tr>		</td></tr>
	<tr><th>xmlParsError</th>		<tr><th>xmlParsError</th>
Line 129:		Line 129:
	</table>		</table>

	<h4>~~Usage notes~~</h4>		<h4>XmlParseErrorReason enumeration</h4>
	~~<ul>~~		An <var>XmlParseErrorReason</var> enumeration may have one of the following values, each of which is demonstrated in the [[#Example\|examples]] below.
	~~<li>~~An <var>XmlParseErrorReason</var> enumeration may have one of the following values, each of which is demonstrated in the [[#Example\|examples]] below.
	<dl>		<dl>
	<dt><var>InvalidUnicodeCharacter</var>		<dt><var>InvalidUnicodeCharacter</var>
Line 150:		Line 149:
	option of the deserialization method.		option of the deserialization method.
	</dl>		</dl>
	~~</ul>~~

	<h4>Example</h4>		<h3>Example</h3>
	The following template is used to apply the <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> deserialization method to a series of test ''input-string'' values to demonstrate the <var>XmlParseError</var> exception output:		The following template is used to apply the <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> deserialization method to a series of test ''input-string'' values to demonstrate the <var>XmlParseError</var> exception output:
	<p class="code"> [[try]]		<p class="code"> [[try]]

JAL2 at 14:53, 17 May 2011

2011-05-17T14:53:17Z

← Older revision		Revision as of 14:53, 17 May 2011
Line 85:		Line 85:
	{{Template:XmlParseError:New subtitle}}		{{Template:XmlParseError:New subtitle}}

	This constructor generates an instance of an <var>~~[[XmlParseError_class\|~~XmlParseError]]</var> exception. As shown in the syntax that follows, the <var>New</var> method arguments set the values of the class properties that have the corresponding names.		This constructor generates an instance of an <var>XmlParseError</var> exception. As shown in the syntax that follows, the <var>New</var> method arguments set the values of the class properties that have the corresponding names.

	Each argument to <var>New</var> sets the value of the corresponding property of the newly constructed <var>XmlParseError</var> object.		Each argument to <var>New</var> sets the value of the corresponding property of the newly constructed <var>XmlParseError</var> object.