New (XmlParseError constructor): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
<span class="pageSubtitle"><section begin=dpl_desc/>Create new XmlParseError instance<section end=dpl_desc/></span> | <span class="pageSubtitle"><section begin=dpl_desc/>Create new XmlParseError instance<section end=dpl_desc/></span> | ||
[[Category:XmlParseError methods|New constructor]] | [[Category:XmlParseError methods|New constructor]] | ||
| Line 5: | Line 4: | ||
New is a member of the [[XmlParseError class]]. | New is a member of the [[XmlParseError class]]. | ||
</p> | </p> | ||
As shown in the syntax that follows, | As shown in the syntax that follows, | ||
the New method arguments set the values of the class properties that have the | the <var>New</var> method arguments set the values of the class properties that have the | ||
corresponding names. | corresponding names. | ||
==Syntax== | ==Syntax== | ||
| Line 14: | Line 13: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%xmlParsErr</th> | <tr><th>%xmlParsErr</th> | ||
<td>A reference to an instance of an XmlParseError object. | <td>A reference to an instance of an <var>XmlParseError</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th | <tr><th>Reason</th> | ||
<td>This name required parameter specifies the value to be assigned to the exception object's Reason property. | <td>This [[Methods#Named parameters|name required]] parameter specifies the value to be assigned to the exception object's <var>Reason</var> property. | ||
The Reason parameter is '''not''' optional. | <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. | |||
</td></tr> | </td></tr> | ||
<tr><th | <tr><th>CharacterPosition</th> | ||
<td>This name required parameter specifies the numeric value (''num'') to be assigned to the object's CharacterPosition property. Its default value is 0. | <td>This name required parameter specifies the numeric value (''num'') to be assigned to the object's <var>CharacterPosition</var> property. Its default value is 0. | ||
</td></tr> | </td></tr> | ||
<tr><th | <tr><th>Description</th> | ||
<td>This name required parameter specifies the string value (''string'') to be assigned to the object's Description property. Its default value is a null string. | <td>This name required parameter specifies the string value (''string'') to be assigned to the object's <var>Description</var> property. Its default value is a null string. | ||
</td></tr> | </td></tr> | ||
<tr><th | <tr><th>InputHexValue</th> | ||
<td>This name required parameter specifies the string value (''string'') to be assigned to the object's InputHexValue property. Its default value is a null string. | <td>This name required parameter specifies the string value (''string'') to be assigned to the object's <var>InputHexValue</var> property. Its default value is a null string. | ||
</td></tr></table> | </td></tr></table> | ||
Revision as of 21:11, 2 March 2011
<section begin=dpl_desc/>Create new XmlParseError instance<section end=dpl_desc/>
New is a member of the XmlParseError class.
As shown in the syntax that follows, the New method arguments set the values of the class properties that have the corresponding names.
Syntax
%xmlParseError = [%(XmlParseError):]New( Reason= xmlParseErrorReason, - [CharacterPosition= number], - [Description= string], - [InputHexValue= string])
Syntax terms
| %xmlParsErr | A reference to an instance of an XmlParseError object. |
|---|---|
| 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 name required parameter specifies the numeric value (num) to be assigned to the object's CharacterPosition property. Its default value is 0. |
| Description | This 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 name required parameter specifies the string value (string) to be assigned to the object's InputHexValue property. Its default value is a null string. |