New (XmlParseError constructor): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (match syntax table to syntax template, tags and edits) |
||
| Line 1: | Line 1: | ||
{{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. | |||
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 6: | Line 7: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th> | <tr><th>xmlParsError</th> | ||
<td>A reference to an instance of | <td>A reference to an instance of a <var>[[XmlParseError_class|XmlParseError]]</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th>%(XmlParseError)</th><td>The class name in parentheses denotes a shared method.</td></tr> | |||
<tr><th>Reason</th> | <tr><th>Reason</th> | ||
<td>This [[Methods#Named parameters| | <td>This <var>[[Methods#Named parameters|Name-Required]]</var> 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 in [[Reason (XmlParseError property)#Syntax terms|"Reason Syntax terms"]]. | <var>Reason</var> settings are <var>XmlParseErrorReason</var> enumeration values, which are described in [[Reason (XmlParseError property)#Syntax terms|"Reason Syntax terms"]]. | ||
The <var>Reason</var> parameter is '''not''' optional. | The <var>Reason</var> parameter is '''not''' optional. | ||
</td></tr> | </td></tr> | ||
<tr><th>CharacterPosition</th> | <tr><th>CharacterPosition</th> | ||
<td>This | <td>This optional, but <var>Name-Required</var>, parameter specifies the numeric value (''number'') 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>Description</th> | <tr><th>Description</th> | ||
<td>This | <td>This optional, but <var>Name-Required</var>, parameter specifies the string value (''string'') 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>InputHexValue</th> | <tr><th>InputHexValue</th> | ||
<td>This | <td>This optional, but <var>Name-Required</var>, parameter specifies the string value (''string'') to be assigned to the object's <var>[[InputHexValue_(XmlParseError_property)|InputHexValue]]</var> property. Its default value is a null string. | ||
</td></tr></table> | </td></tr></table> | ||
==See also== | ==See also== | ||
{{Template:XmlParseError:New footer}} | {{Template:XmlParseError:New footer}} | ||
Revision as of 12:17, 24 April 2011
Create a new XmlParseError object (XmlParseError class) This constructor generates an instance of an XmlParseError exception. As shown in the syntax that follows, the New method arguments set the values of the class properties that have the corresponding names.
Each argument to New sets the value of the corresponding property of the newly constructed XmlParseError object.
Syntax
%xmlParseError = [%(XmlParseError):]New( Reason= xmlParseErrorReason, - [CharacterPosition= number], - [Description= string], - [InputHexValue= string])
Syntax terms
| xmlParsError | A reference to an instance of a XmlParseError object. |
|---|---|
| %(XmlParseError) | The class name in parentheses denotes a shared method. |
| Reason | This Name-Required parameter specifies the value to be assigned to the exception object's Reason property.
Reason settings are XmlParseErrorReason enumeration values, which are described in "Reason Syntax terms". The Reason parameter is not optional. |
| CharacterPosition | This optional, but Name-Required, parameter specifies the numeric value (number) to be assigned to the object's CharacterPosition property. Its default value is 0. |
| Description | This optional, but Name-Required, parameter specifies the string value (string) to be assigned to the object's Description property. Its default value is a null string. |
| InputHexValue | This optional, but Name-Required, parameter specifies the string value (string) to be assigned to the object's InputHexValue property. Its default value is a null string. |