New (AddToRecordError constructor): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (match syntax table to syntax template, tags and . . . well, that's about it . . . I don't know this one either)
Line 1: Line 1:
{{Template:AddToRecordError:New subtitle}}
{{Template:AddToRecordError:New subtitle}}
<var>New</var> set the values of the properties of the class that have the corresponding names.


As shown in the syntax that follows,
the <var>New</var> method arguments set the values of the properties of the class that have the
corresponding names.
==Syntax==
==Syntax==
{{Template:AddToRecordError:New syntax}}
{{Template:AddToRecordError:New syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%a2RecErr</th>
<tr><th>%addToRecordError</th>
<td>An <var>AddToRecordError</var> object.
<td>An <var>AddToRecordError</var> object.
</td></tr>
</td></tr>
<tr><th><b>Reason=</b>reasonEnum</th>
<tr><th>Reason</th>
<td>This name required parameter specifies the <var>AddToRecordErrorReason</var> enumeration value (''reasonEnum'') to be assigned to the exception object's <var>[[Reason (AddToRecordError property)|Reason]]</var> property.
<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.
The Reason parameter is '''not''' optional.
</td></tr>
</td></tr>
<tr><th><b>Description=</b>string</th>
<tr><th>Description</th>
<td>This name required parameter specifies the string value (''string'') to be assigned to the object's <var>[[Description (AddToRecordError property)|Description]]</var> property. This parameter is optional; 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><b>UntranslatableHexValue=</b>hexString</th>
<tr><th>UntranslatableHexValue</th>
<td>This name required parameter specifies the string value (''hexString'') to be assigned to the object's <var>[[UntranslatableHexValue (AddToRecordError property)|UntranslatableHexValue]]</var> property. This parameter is optional; 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><b>FieldOrFieldgroupName=</b>string</th>
<tr><th>FieldOrFieldgroupName</th>
<td>This name required parameter specifies the string value (''string'') to be assigned to the object's <var>[[FieldOrFieldgroupName (AddToRecordError property)|FieldOrFieldgroupName]]</var> property. This parameter is optional; 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><b>NodeName=</b>string</th>
<tr><th>NodeName</th>
<td>This name required parameter specifies the string value (''string'') to be assigned to the object's <var>[[NodeName (AddToRecordError property)|NodeName]]</var> property. This parameter is optional; 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><b>NodeType=</b>xmlNodeTypeEnum</th>
<tr><th>NodeType</th>
<td>This name required parameter specifies the <var>XmlNodeType</var> enumeration value (''xmlNodeTypeEnum'') to be assigned to the object's <var>[[NodeType (AddToRecordError property)|NodeType]]</var> property. This parameter is optional; 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><b>Value=</b>string</th>
<tr><th>Value</th>
<td>This name required parameter specifies the string value (''string'') to be assigned to the object's <var>[[Value (AddToRecordError property)|Value]]</var> property. This parameter is optional; 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><b>InputRecordNumber=</b>number</th>
<tr><th>InputRecordNumber</th>
<td>This name required parameter specifies the numeric value (''number'') to be assigned to the object's <var>[[InputRecordNumber (AddToRecordError property)|InputRecordNumber]]</var> property. This parameter is optional; 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>
 
==Usage Notes==
<ul>
<li><var>New</var> is available in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.8 and later.
</ul>


</td></tr></table>
==See also==
==See also==
{{Template:AddToRecordError:New footer}}
{{Template:AddToRecordError:New footer}}

Revision as of 04:41, 1 April 2011

Create new AddToRecordError object (AddToRecordError class)

[Introduced in Sirius Mods 7.8]

New set the values of the properties of the class that have the corresponding names.

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=18792"