New (AddToRecordError constructor): Difference between revisions
m (→Usage Notes) |
m (→Usage Notes) |
||
Line 9: | Line 9: | ||
</td></tr> | </td></tr> | ||
<tr><th><var>Reason</var></th> | <tr><th><var>Reason</var></th> | ||
<td>This <var>[[Methods#Named parameters| | <td>This <var>[[Methods#Named parameters|name required]]</var> parameter specifies the <var>AddToRecordErrorReason</var> enumeration value to be assigned to the exception object's <var class="term>[[Reason (AddToRecordError property)|Reason]]</var> property. <var class="term">Reason</var> is a required parameter. | ||
</td></tr> | </td></tr> | ||
<tr><th><var>Description</var></th> | <tr><th><var>Description</var></th> |
Revision as of 19:37, 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.