New (AddToRecordError constructor): Difference between revisions
m (→Syntax terms) |
m (→Syntax terms) |
||
Line 12: | Line 12: | ||
</td></tr> | </td></tr> | ||
<tr><th><var>Description</var></th> | <tr><th><var>Description</var></th> | ||
<td>This | <td>This name required parameter specifies the string value to be assigned to the object's <var>[[Description (AddToRecordError property)|Description]]</var> property. <var class="term">Description</var> is an optional parameter; the default value is the null string. | ||
</td></tr> | </td></tr> | ||
<tr><th><var>UntranslatableHexValue</var></th> | <tr><th><var>UntranslatableHexValue</var></th> | ||
<td>This | <td>This name required parameter specifies the string value to be assigned to the object's <var>[[UntranslatableHexValue (AddToRecordError property)|UntranslatableHexValue]]</var> property. <var class="term">UntranslatableHexValue</var> is an optional parameter; the default value is the null string and, if supplied, it must be a valid hexadecimal string. | ||
</td></tr> | </td></tr> | ||
<tr><th><var>FieldOrFieldgroupName</var></th> | <tr><th><var>FieldOrFieldgroupName</var></th> | ||
<td>This | <td>This name required parameter specifies the string value to be assigned to the object's <var>[[FieldOrFieldgroupName (AddToRecordError property)|FieldOrFieldgroupName]]</var> property. <var class="term">FieldOrFieldgroupName</var> is an optional parameter; the default value is the null string. | ||
</td></tr> | </td></tr> | ||
<tr><th><var>NodeName</var></th> | <tr><th><var>NodeName</var></th> | ||
<td>This | <td>This name required parameter specifies the string value to be assigned to the object's <var>[[NodeName (AddToRecordError property)|NodeName]]</var> property. <var class="term">NodeName</var> is an optional parameter; the default value is the null string. | ||
</td></tr> | </td></tr> | ||
<tr><th><var>NodeType</var></th> | <tr><th><var>NodeType</var></th> | ||
<td>This | <td>This name required parameter specifies the <var>XmlNodeType</var> enumeration value to be assigned to the object's <var>[[NodeType (AddToRecordError property)|NodeType]]</var> property. <var class="term">NodeType</var> is an optional parameter; the default value is Null. | ||
</td></tr> | </td></tr> | ||
<tr><th><var>Value</var></th> | <tr><th><var>Value</var></th> | ||
<td>This | <td>This name required parameter specifies the string value to be assigned to the object's <var>[[Value (AddToRecordError property)|Value]]</var> property. <var class="term">Value</var> is an optional parameter; the default value is the null string. | ||
</td></tr> | </td></tr> | ||
<tr><th><var>InputRecordNumber</var></th> | <tr><th><var>InputRecordNumber</var></th> | ||
<td>This | <td>This name required parameter specifies the numeric value to be assigned to the object's <var>[[InputRecordNumber (AddToRecordError property)|InputRecordNumber]]</var> property. <var class="term">InputRecordNumber</var> is an optional parameter; the default value is 0. | ||
</td></tr></table> | </td></tr></table> | ||
Revision as of 22:14, 4 May 2011
Create new AddToRecordError object (AddToRecordError class)
[Introduced in Sirius Mods 7.8]
Each argument to New sets the value of the corresponding property of the newly constructed AddToRecordError object.
Syntax
%addToRecordError = [%(AddToRecordError):]New( Reason= addToRecordErrorReason, - [Description= string], - [UntranslatableHexValue= string], - [FieldOrFieldgroupName= string], - [NodeName= string], - [NodeType= xmlNodeType], - [Value= string], - [InputRecordNumber= number])
Syntax terms
%addToRecordError | An AddToRecordError object. |
---|---|
Reason | This name required parameter specifies the AddToRecordErrorReason enumeration value to be assigned to the exception object's Reason property. Reason is a required parameter. |
Description | This name required parameter specifies the string value to be assigned to the object's Description property. Description is an optional parameter; the default value is the null string. |
UntranslatableHexValue | This name required parameter specifies the string value to be assigned to the object's UntranslatableHexValue property. UntranslatableHexValue is an optional parameter; the default value is the null string and, if supplied, it must be a valid hexadecimal string. |
FieldOrFieldgroupName | This name required parameter specifies the string value to be assigned to the object's FieldOrFieldgroupName property. FieldOrFieldgroupName is an optional parameter; the default value is the null string. |
NodeName | This name required parameter specifies the string value to be assigned to the object's NodeName property. NodeName is an optional parameter; the default value is the null string. |
NodeType | This name required parameter specifies the XmlNodeType enumeration value to be assigned to the object's NodeType property. NodeType is an optional parameter; the default value is Null. |
Value | This name required parameter specifies the string value to be assigned to the object's Value property. Value is an optional parameter; the default value is the null string. |
InputRecordNumber | This name required parameter specifies the numeric value to be assigned to the object's InputRecordNumber property. InputRecordNumber is an optional parameter; the default value is 0. |
Usage Notes
- New is available in Sirius Mods Version 7.8 and later.