New (AddToRecordError constructor): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
Line 35: Line 35:
==Usage Notes==
==Usage Notes==
<ul>
<ul>
<li><var>New</var> is available in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.8 and later.
<li><var>New</var> is available in <var class="product">[[Sirius Mods]]</var> Version 7.8 and later.
</ul>
</ul>


==See also==
==See also==
{{Template:AddToRecordError:New footer}}
{{Template:AddToRecordError:New footer}}

Revision as of 22:46, 2 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.

See also