Reason (AddToRecordError property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (match syntax table to syntax template, tags and edits)
Line 1: Line 1:
{{Template:AddToRecordError:Reason subtitle}}
{{Template:AddToRecordError:Reason subtitle}}
==Syntax==
==Syntax==
{{Template:AddToRecordError:Reason syntax}}
{{Template:AddToRecordError:Reason syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%reason</th>
<tr><th>%addToRecordErrorReason</th>
<td>This <var>AddToRecordErrorReason</var> enumeration value describes the reason for the translation failure.
<td>This <var>AddToRecordErrorReason</var> enumeration value describes the reason for the translation failure.
</td></tr>
</td></tr>
<tr><th>%a2RecErr</th>
<tr><th>addToRecordError</th>
<td>An <var>AddToRecordError</var> object.
<td>An <var>[[AddToRecordError]]</var> object.
</td></tr></table>


</td></tr></table>
==Usage notes==
==Usage notes==
<ul>
<ul><li>An <var class="term">AddToRecordErrorReason</var> enumeration may have one of the following values:
<li>An <var>AddToRecordErrorReason</var> enumeration may have one of the following values:
<dl>
<dl>
<dt>InvalidNode
<dt>InvalidNode
<dd>A node in <var>[[AddToRecord (XmlDoc subroutine)|AddToRecord]]</var>'s method object <var>[[XmlDoc class|XmlDoc]]</var> does not conform to the structure as
<dd>A node in <var>[[AddToRecord (XmlDoc subroutine)|AddToRecord]]</var>'s method object <var>[[XmlDoc class|XmlDoc]]</var> does not conform to the structure as created by the LoadFromRecord subroutine.
created by the LoadFromRecord subroutine.
<dt>UntranslatableFieldName
<dt>UntranslatableFieldName
<dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not translatable to EBCDIC.
<dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not translatable to EBCDIC.
Line 26: Line 23:
<dd>A field value in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not translatable to EBCDIC.
<dd>A field value in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not translatable to EBCDIC.
<dt>InvalidBase64
<dt>InvalidBase64
<dd>A string used for the base64 encoding of a field in <var>AddToRecord</var>'s method object
<dd>A string used for the base64 encoding of a field in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not a valid base64 string.
<var>XmlDoc</var> is not a valid base64 string.
<dt>FieldNameTooLong
<dt>FieldNameTooLong
<dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is longer than 255 characters.
<dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is longer than 255 characters.
Line 33: Line 29:
<dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is longer than 255 characters.
<dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is longer than 255 characters.
<dt>ValueTooLong
<dt>ValueTooLong
<dd>The value of a field in <var>AddToRecord</var>'s method object <var>XmlDoc</var> that is not defined as a
<dd>The value of a field in <var>AddToRecord</var>'s method object <var>XmlDoc</var> that is not defined as a <var>BLOB</var> or <var>CLOB</var> field in the current file is longer than 255 characters or is longer than the defined <var>LEN</var> attribute, if the field is a fixed <var>OCCURS</var> field.
<var>BLOB</var> or <var>CLOB</var> field in the current file is longer than 255 characters or is
longer than the defined <var>LEN</var> attribute, if the field is a fixed
<var>OCCURS</var> field.
<dt>UnknownFieldName
<dt>UnknownFieldName
<dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not defined in the current file.
<dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not defined in the current file.
Line 42: Line 35:
<dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not defined in the current file.
<dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not defined in the current file.
<dt>ExpectedField
<dt>ExpectedField
<dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is defined as a fieldgroup
<dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is defined as a fieldgroup in the current file.
in the current file.
<dt>ExpectedFieldgroup
<dt>ExpectedFieldgroup
<dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is defined as a field
<dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is defined as a field in the current file.
in the current file.
<dt>ErrorAddingField
<dt>ErrorAddingField
<dd>An error occurred adding a field, such as a violation of a
<dd>An error occurred adding a field, such as a violation of a field constraint.
field constraint.
<dt>ErrorAddingFieldgroup
<dt>ErrorAddingFieldgroup
<dd>An error occurred adding a fieldgroup, such as a file full
<dd>An error occurred adding a fieldgroup, such as a file full condition.
condition.
<dt>ErrorObtainingRecord
<dt>ErrorObtainingRecord
<dd><var>AddToRecord</var> was unable to lock the record in exclusive mode.
<dd><var>AddToRecord</var> was unable to lock the record in exclusive mode.
Line 58: Line 47:
<dd>A fieldgroup ID in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not numeric.
<dd>A fieldgroup ID in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not numeric.
<dt>InvalidCodepage
<dt>InvalidCodepage
<dd>The codepage name specified on the <code>codepage</code> attribute of the
<dd>The codepage name specified on the <code>codepage</code> attribute of the <code>Record</code> element in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not a known codepage name.
<code>Record</code> element
in <var>AddToRecord</var>'s method object <var>XmlDoc</var>
is not a known codepage name.
<dt>ErrorAddingMaxFieldgroupID
<dt>ErrorAddingMaxFieldgroupID
<dd>The attempt to set the fieldgroup ID counter in the record
<dd>The attempt to set the fieldgroup ID counter in the record failed; this is a very unusual condition.
failed; this is a very unusual condition.
<dt>InsufficientStorageForLOB
<dt>InsufficientStorageForLOB
<dd>STBL, VTBL, or User Buffer storage was unavailable.
<dd>STBL, VTBL, or User Buffer storage was unavailable.<p>The <var>[[Description (AddToRecordError property)|Description]]</var> property indicates which of these is applicable.</p>
The <var>[[Description (AddToRecordError property)|Description]]</var> property indicates which of these is applicable.
<dt>InvalidVersion
<dt>InvalidVersion
<dd>Invalid value of the <code>version</code> attribute of the <code>Record</code> element
<dd>Invalid value of the <code>version</code> attribute of the <code>Record</code> element in <var>AddToRecord</var>'s method object <var>XmlDoc</var>; the only allowed value is 1.
in <var>AddToRecord</var>'s method object <var>XmlDoc</var>;
the only allowed value is 1.
<dt>InvalidInputRecordNumber
<dt>InvalidInputRecordNumber
<dd>Invalid value of the <code>number</code> attribute of the <code>Record</code> element
<dd>Invalid value of the <code>number</code> attribute of the <code>Record</code> element in <var>AddToRecord</var>'s method object <var>XmlDoc</var>; it must either be -1 or a non-negative integer.
in <var>AddToRecord</var>'s method object <var>XmlDoc</var>;
it must either be -1 or a non-negative integer.
</dl>
</dl>
<li>As with all enumerations, you use
<li>As with all enumerations, you use the <code>ToString</code> method to convert an enumeration value to a character string whose value is the name of the enumeration value.
the <code>ToString</code> method to convert an enumeration value to a
character string whose value is the name of the enumeration value.
</ul>
</ul>
==See also==
==See also==
{{Template:AddToRecordError:Reason footer}}
{{Template:AddToRecordError:Reason footer}}

Revision as of 05:21, 10 April 2011

Enumerated reason for error (AddToRecordError class)

[Introduced in Sirius Mods 7.8]

Syntax

%addToRecordErrorReason = addToRecordError:Reason

Syntax terms

%addToRecordErrorReason This AddToRecordErrorReason enumeration value describes the reason for the translation failure.
addToRecordError An AddToRecordError object.

Usage notes

  • An AddToRecordErrorReason enumeration may have one of the following values:
    InvalidNode
    A node in AddToRecord's method object XmlDoc does not conform to the structure as created by the LoadFromRecord subroutine.
    UntranslatableFieldName
    A field name in AddToRecord's method object XmlDoc is not translatable to EBCDIC.
    UntranslatableFieldgroupName
    A fieldgroup name in AddToRecord's method object XmlDoc is not translatable to EBCDIC.
    UntranslatableValue
    A field value in AddToRecord's method object XmlDoc is not translatable to EBCDIC.
    InvalidBase64
    A string used for the base64 encoding of a field in AddToRecord's method object XmlDoc is not a valid base64 string.
    FieldNameTooLong
    A field name in AddToRecord's method object XmlDoc is longer than 255 characters.
    FieldgroupNameTooLong
    A fieldgroup name in AddToRecord's method object XmlDoc is longer than 255 characters.
    ValueTooLong
    The value of a field in AddToRecord's method object XmlDoc that is not defined as a BLOB or CLOB field in the current file is longer than 255 characters or is longer than the defined LEN attribute, if the field is a fixed OCCURS field.
    UnknownFieldName
    A field name in AddToRecord's method object XmlDoc is not defined in the current file.
    UnknownFieldgroupName
    A fieldgroup name in AddToRecord's method object XmlDoc is not defined in the current file.
    ExpectedField
    A field name in AddToRecord's method object XmlDoc is defined as a fieldgroup in the current file.
    ExpectedFieldgroup
    A fieldgroup name in AddToRecord's method object XmlDoc is defined as a field in the current file.
    ErrorAddingField
    An error occurred adding a field, such as a violation of a field constraint.
    ErrorAddingFieldgroup
    An error occurred adding a fieldgroup, such as a file full condition.
    ErrorObtainingRecord
    AddToRecord was unable to lock the record in exclusive mode.
    InvalidFieldgroupID
    A fieldgroup ID in AddToRecord's method object XmlDoc is not numeric.
    InvalidCodepage
    The codepage name specified on the codepage attribute of the Record element in AddToRecord's method object XmlDoc is not a known codepage name.
    ErrorAddingMaxFieldgroupID
    The attempt to set the fieldgroup ID counter in the record failed; this is a very unusual condition.
    InsufficientStorageForLOB
    STBL, VTBL, or User Buffer storage was unavailable.

    The Description property indicates which of these is applicable.

    InvalidVersion
    Invalid value of the version attribute of the Record element in AddToRecord's method object XmlDoc; the only allowed value is 1.
    InvalidInputRecordNumber
    Invalid value of the number attribute of the Record element in AddToRecord's method object XmlDoc; it must either be -1 or a non-negative integer.
  • As with all enumerations, you use the ToString method to convert an enumeration value to a character string whose value is the name of the enumeration value.

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Reason_(AddToRecordError_property)&oldid=18881"