New (AddToRecordError constructor): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (consistency is the key)
m (consistency is the key)
Line 8: Line 8:
<td>An <var>AddToRecordError</var> object.
<td>An <var>AddToRecordError</var> object.
</td></tr>
</td></tr>
<tr><th>Reason</th>
<tr><th><var>Reason</var></th>
<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>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>Description</th>
<tr><th><var>Description</var></th>
<td>This <var>Name-Required</var> 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>This <var>Name-Required</var> 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>UntranslatableHexValue</th>
<tr><th><var>UntranslatableHexValue</var></th>
<td>This <var>Name-Required</var> 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>This <var>Name-Required</var> 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>FieldOrFieldgroupName</th>
<tr><th><var>FieldOrFieldgroupName</var></th>
<td>This <var>Name-Required</var> 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>This <var>Name-Required</var> 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>NodeName</th>
<tr><th><var>NodeName</var></th>
<td>This <var>Name-Required</var> 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>This <var>Name-Required</var> 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>NodeType</th>
<tr><th><var>NodeType</var></th>
<td>This <var>Name-Required</var> 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>This <var>Name-Required</var> 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>Value</th>
<tr><th><var>Value</var></th>
<td>This <var>Name-Required</var> 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>This <var>Name-Required</var> 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>InputRecordNumber</th>
<tr><th><var>InputRecordNumber</var></th>
<td>This <var>Name-Required</var> 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>This <var>Name-Required</var> 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:16, 12 April 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

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=New_(AddToRecordError_constructor)&oldid=18796"