XPathError class - Revision history

JAL: link repair

2014-11-18T21:59:19Z

link repair

← Older revision		Revision as of 21:59, 18 November 2014
Line 28:		Line 28:
	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. </li>
	about the conventions followed.		<li>[[XPathError methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
	<li>[[XPathError methods syntax~~\|"XPathError methods syntax"~~]] is a single page that contains the syntax diagrams of all the methods in the class.
	</ul>		</ul>

Line 121:		Line 120:
	</table>		</table>

	<p class="note">'''Note:''' 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"]].</p>		<p class="note">'''Note:''' 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]].</p>

	[[Category:System exception classes]]		[[Category:System exception classes]]

JAL: typo fix

2014-06-04T20:32:43Z

typo fix

← Older revision		Revision as of 20:32, 4 June 2014
Line 20:		Line 20:
	</p>		</p>

	This class is new in version 7.8 of the <var class="~~prod~~">[[Sirius Mods]]</var>.		This class is new in version 7.8 of the <var class="product">[[Sirius Mods]]</var>.

JAL at 19:44, 4 June 2014

2014-06-04T19:44:16Z

← Older revision		Revision as of 19:44, 4 June 2014
Line 20:		Line 20:
	</p>		</p>

	This class is new in version 7.8 of the <var class="prod">Sirius Mods</var>.		This class is new in version 7.8 of the <var class="prod">[[Sirius Mods]]</var>.

JAL: /* XPathErrorReason enumeration */

2014-06-04T19:42:35Z

XPathErrorReason enumeration

← Older revision		Revision as of 19:42, 4 June 2014
Line 112:		Line 112:
	====XPathErrorReason enumeration====		====XPathErrorReason enumeration====
	An <var>XPathErrorReason</var> [[Enumerations\|enumeration]] may have one of the following values:		An <var>XPathErrorReason</var> [[Enumerations\|enumeration]] may have one of the following values:
	<table class="~~optionTable~~">		<table class="thJustBold">
	<tr><th>SyntaxError</th>		<tr><th>SyntaxError</th>
	<td>A violation of the syntax of an XPath expression.</td></tr>		<td>A violation of the syntax of an XPath expression.</td></tr>
Line 121:		Line 121:
	</table>		</table>

	'''Note:''' 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"]].		<p class="note">'''Note:''' 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"]].</p>

	[[Category:System exception classes]]		[[Category:System exception classes]]

JAL at 22:17, 28 November 2012

2012-11-28T22:17:34Z

← Older revision		Revision as of 22:17, 28 November 2012
Line 1:		Line 1:
	~~<!-- XPathError class -->~~
	__NOTOC__		__NOTOC__
	An <var>XPathError</var> exception can be thrown by various methods in the [[XmlDoc API]]. It indicates an error either in the syntax of an [[XPath]] argument to the method, or in the results returned by that XPath expression. The various read-only properties of an <var>XPathError</var> object (which can be set by the <var>[[Exceptions#Try and Catch\|Catch]]</var> statement) provide information about the failed operation.		An <var>XPathError</var> exception can be thrown by various methods in the [[XmlDoc API]]. It indicates an error either in the syntax of an [[XPath]] argument to the method, or in the results returned by that XPath expression. The various read-only properties of an <var>XPathError</var> object (which can be set by the <var>[[Exceptions#Try and Catch\|Catch]]</var> statement) provide information about the failed operation.

JAL at 21:29, 28 November 2012

2012-11-28T21:29:42Z

← Older revision		Revision as of 21:29, 28 November 2012
Line 86:		Line 86:
	<tr><th><var>Reason</var></th>		<tr><th><var>Reason</var></th>
	<td>This [[Methods#Named parameters\|name required]] parameter is an <var>[[#XPathErrorReason enumeration\|XPathErrorReason]]</var> enumeration value which specifies the value to be assigned to the exception object's <var>[[Reason (XPathError property)\|Reason]]</var> property.		<td>This [[Methods#Named parameters\|name required]] parameter is an <var>[[#XPathErrorReason enumeration\|XPathErrorReason]]</var> enumeration value which specifies the value to be assigned to the exception object's <var>[[Reason (XPathError property)\|Reason]]</var> property.
	The <var>Reason ~~parameter~~</var> is '''not''' optional.</td></tr>		The <var>Reason</var> parameter is '''not''' optional.</td></tr>

	<tr><th><var>Description</var></th>		<tr><th><var>Description</var></th>

JAL at 00:55, 22 November 2012

2012-11-22T00:55:57Z

New page

__NOTOC__
An <var>XPathError</var> exception can be thrown by various methods in the [[XmlDoc API]]. It indicates an error either in the syntax of an [[XPath]] argument to the method, or in the results returned by that XPath expression. The various read-only properties of an <var>XPathError</var> object (which can be set by the <var>[[Exceptions#Try and Catch|Catch]]</var> statement) provide information about the failed operation.

An example of using the <var>XPathError</var> exception is:
<p class="code">%err Object XPathError
Try
%d:Print('a b c')
Catch XPathError To %err
PrintText {~} = {%err:Reason}
PrintText {~} = {%err:Description}
PrintText {~} = {%err:CharacterPosition}
End Try
</p>
Since the expression (<code>a b c</code>) in the above invocation of the <var>[[Print (XmlDoc/XmlNode subroutine)|Print]]</var> method is not a valid
XPath expression, the above fragment will result in the following:
<p class="output">%err:Reason = SyntaxError
%err:Description = Expect "/" for new step or "[" for
predicate
%err:CharacterPosition = 3
</p>

This class is new in version 7.8 of the <var class="prod">Sirius Mods</var>.

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

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

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

====Syntax terms====
<table class="syntaxTable">
<tr><th>%number</th>
<td>The position of the character at which the exception was thrown.</td></tr>

<tr><th>xPathError</th>
<td>An <var>XPathError</var> object.</td></tr>
</table>

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

===Syntax===
{{Template:XPathError: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>xPathError</th>
<td>An <var>XPathError</var> object.</td></tr>
</table>

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

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

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

====Syntax terms====
<table class="syntaxTable">

<tr><th>%xPathError</th>
<td>A reference to an instance of an <var>XPathError</var> object.

<tr><th><var>[%(XPathError):]</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 is an <var>[[#XPathErrorReason enumeration|XPathErrorReason]]</var> enumeration value which specifies the value to be assigned to the exception object's <var>[[Reason (XPathError property)|Reason]]</var> property.
The <var>Reason parameter</var> is '''not''' optional.</td></tr>

<tr><th><var>Description</var></th>
<td>This optional, name required, parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[Description (XPathError property)|Description]]</var> property.</td></tr>

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

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

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

====Syntax terms====
<table class="syntaxTable">
<tr><th>%xPathErrorReason</th>
<td>This <var>XPathErrorReason</var> enumeration value (see below) describes the reason for the translation failure.</td></tr>

<tr><th>xPathError</th>
<td>An <var>XPathError</var> object.</td></tr>
</table>

====XPathErrorReason enumeration====
An <var>XPathErrorReason</var> [[Enumerations|enumeration]] may have one of the following values:
<table class="optionTable">
<tr><th>SyntaxError</th>
<td>A violation of the syntax of an XPath expression.</td></tr>

<tr><th>EmptyResult</th>
<td>No nodes are matched by the XPath expression, and the method
requires at least one matching node.</td></tr>
</table>

'''Note:''' 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"]].

[[Category:System exception classes]]

JAL2 at 18:44, 7 August 2012

2012-08-07T18:44:48Z

← Older revision		Revision as of 18:44, 7 August 2012
Line 65:		Line 65:


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

Line 71:		Line 71:
	<h3>Syntax</h3>		<h3>Syntax</h3>
	{{Template:XPathError:New syntax}}		{{Template:XPathError:New syntax}}

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

			<tr><th><var>[%(XPathError):]</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 is an <var>[[#XPathErrorReason enumeration\|XPathErrorReason]]</var> enumeration value which specifies the value to be assigned to the exception object's <var>[[Reason (XPathError property)\|Reason]]</var> property.		<td>This [[Methods#Named parameters\|name required]] parameter is an <var>[[#XPathErrorReason enumeration\|XPathErrorReason]]</var> enumeration value which specifies the value to be assigned to the exception object's <var>[[Reason (XPathError property)\|Reason]]</var> property.
	The <var>Reason parameter</var> is '''not''' optional.		The <var>Reason parameter</var> is '''not''' optional.
	</td></tr>		</td></tr>

	<tr><th><var>Description</var></th>		<tr><th><var>Description</var></th>
	<td>This name required parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[Description (XPathError property)\|Description]]</var> property.		<td>This name required parameter specifies the string value (<var class="term">string</var>) to be assigned to the object's <var>[[Description (XPathError property)\|Description]]</var> property.
	</td></tr>		</td></tr>

	<tr><th><var>CharacterPosition</var></th>		<tr><th><var>CharacterPosition</var></th>
	<td>This name required parameter specifies the numeric value (<var class="term">number</var>) to be assigned to the object's <var>[[CharacterPosition (XPathError property)\|CharacterPosition]]</var> property.		<td>This name required parameter specifies the numeric value (<var class="term">number</var>) to be assigned to the object's <var>[[CharacterPosition (XPathError property)\|CharacterPosition]]</var> property.

JAL2 at 21:37, 16 August 2011

2011-08-16T21:37:17Z

← Older revision		Revision as of 21:37, 16 August 2011
Line 102:		Line 102:
	</td></tr></table>		</td></tr></table>
	<h4>XPathErrorReason enumeration</h4>		<h4>XPathErrorReason enumeration</h4>
	An <var>XPathErrorReason</var> enumeration may have one of the following values:		An <var>XPathErrorReason</var> [[Enumerations\|enumeration]] may have one of the following values:
	<table class="optionTable">		<table class="optionTable">
	<tr><th>SyntaxError</th>		<tr><th>SyntaxError</th>
Line 110:		Line 110:
	requires at least one matching node.</td></tr>		requires at least one matching node.</td></tr>
	</table>		</table>
	~~'''Note:''' As with all enumerations, you use~~
	~~the <code>ToString</code> method to convert an enumeration value to a~~
	~~character string whose value is the name of the enumeration value.~~

			'''Note:''' 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"]].

	[[Category:System exception classes]]		[[Category:System exception classes]]

JAL2 at 21:15, 27 July 2011

2011-07-27T21:15:06Z

← Older revision		Revision as of 21:15, 27 July 2011
Line 74:		Line 74:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%xPathError</th><td>A reference to an instance of an <var>XPathError</var> object.		<tr><th>%xPathError</th><td>A reference to an instance of an <var>XPathError</var> object.
	<tr><th><var>%(XPathError)</var></th><td>The class name in parentheses denotes a ~~shared method~~.</td></tr>		<tr><th><var>%(XPathError)</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 is an <var>[[#XPathErrorReason enumeration\|XPathErrorReason]]</var> enumeration value which specifies the value to be assigned to the exception object's <var>[[Reason (XPathError property)\|Reason]]</var> property.		<td>This [[Methods#Named parameters\|name required]] parameter is an <var>[[#XPathErrorReason enumeration\|XPathErrorReason]]</var> enumeration value which specifies the value to be assigned to the exception object's <var>[[Reason (XPathError property)\|Reason]]</var> property.