New (XmlParseError constructor): Difference between revisions
m (1 revision) |
m (→Syntax terms) |
||
Line 12: | Line 12: | ||
<tr><th>%(XmlParseError)</th><td>The class name in parentheses denotes a shared method.</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 | <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 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. |
Revision as of 21:48, 4 May 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. |