New (AddToRecordError constructor): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 1: Line 1:
 
{{Template:AddToRecordError:New subtitle}}
<span class="pageSubtitle"><section begin=dpl_desc/>Create new AddToRecordError instance<section end=dpl_desc/></span>


As shown in the syntax that follows,
As shown in the syntax that follows,

Revision as of 19:20, 15 March 2011

Create new AddToRecordError object (AddToRecordError class)

[Introduced in Sirius Mods 7.8]

As shown in the syntax that follows, the New method arguments 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

%a2RecErr An AddToRecordError object.
Reason=reasonEnum This name required parameter specifies the AddToRecordErrorReason enumeration value (reasonEnum) to be assigned to the exception object's Reason property.

The Reason parameter is not optional.

Description=string This name required parameter specifies the string value (string) to be assigned to the object's Description property. This parameter is optional; the default value is the null string.
UntranslatableHexValue=hexString This name required parameter specifies the string value (hexString) to be assigned to the object's UntranslatableHexValue property. This parameter is optional; the default value is the null string and, if supplied, it must be a valid hexadecimal string.
FieldOrFieldgroupName=string This name required parameter specifies the string value (string) to be assigned to the object's FieldOrFieldgroupName property. This parameter is optional; the default value is the null string.
NodeName=string This name required parameter specifies the string value (string) to be assigned to the object's NodeName property. This parameter is optional; the default value is the null string.
NodeType=xmlNodeTypeEnum This name required parameter specifies the XmlNodeType enumeration value (xmlNodeTypeEnum) to be assigned to the object's NodeType property. This parameter is optional; the default value is Null.
Value=string This name required parameter specifies the string value (string) to be assigned to the object's Value property. This parameter is optional; the default value is the null string.
InputRecordNumber=number This name required parameter specifies the numeric value (number) to be assigned to the object's InputRecordNumber property. This parameter is optional; the default value is 0.

See also