|
|
| Line 1: |
Line 1: |
| {{Template:AddToRecordError:Reason subtitle}}
| | #REDIRECT [[AddToRecordError class#Reason property|Reason property]] |
| ==Syntax==
| | [[Category:AddToRecordError methods|Reason property]] |
| {{Template:AddToRecordError:Reason syntax}}
| |
| ===Syntax terms===
| |
| <table class="syntaxTable">
| |
| <tr><th>%addToRecordErrorReason</th>
| |
| <td>This <var>AddToRecordErrorReason</var> enumeration value describes the reason for the translation failure.
| |
| </td></tr>
| |
| <tr><th>addToRecordError</th>
| |
| <td>An <var>[[AddToRecordError_class|AddToRecordError]]</var> object.
| |
| </td></tr></table>
| |
| | |
| ==Usage notes==
| |
| <ul><li>An <var class="term">AddToRecordErrorReason</var> enumeration may have one of the following values:
| |
| <dl>
| |
| <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 created by the LoadFromRecord subroutine.
| |
| <dt>UntranslatableFieldName
| |
| <dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not translatable to EBCDIC.
| |
| <dt>UntranslatableFieldgroupName
| |
| <dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not translatable to EBCDIC.
| |
| <dt>UntranslatableValue
| |
| <dd>A field value in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not translatable to EBCDIC.
| |
| <dt>InvalidBase64
| |
| <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.
| |
| <dt>FieldNameTooLong
| |
| <dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is longer than 255 characters.
| |
| <dt>FieldgroupNameTooLong
| |
| <dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is longer than 255 characters.
| |
| <dt>ValueTooLong
| |
| <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.
| |
| <dt>UnknownFieldName
| |
| <dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not defined in the current file.
| |
| <dt>UnknownFieldgroupName
| |
| <dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not defined in the current file.
| |
| <dt>ExpectedField
| |
| <dd>A field name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is defined as a fieldgroup in the current file.
| |
| <dt>ExpectedFieldgroup
| |
| <dd>A fieldgroup name in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is defined as a field in the current file.
| |
| <dt>ErrorAddingField
| |
| <dd>An error occurred adding a field, such as a violation of a field constraint.
| |
| <dt>ErrorAddingFieldgroup
| |
| <dd>An error occurred adding a fieldgroup, such as a file full condition.
| |
| <dt>ErrorObtainingRecord
| |
| <dd><var>AddToRecord</var> was unable to lock the record in exclusive mode.
| |
| <dt>InvalidFieldgroupID
| |
| <dd>A fieldgroup ID in <var>AddToRecord</var>'s method object <var>XmlDoc</var> is not numeric.
| |
| <dt>InvalidCodepage
| |
| <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.
| |
| <dt>ErrorAddingMaxFieldgroupID
| |
| <dd>The attempt to set the fieldgroup ID counter in the record failed; this is a very unusual condition.
| |
| <dt>InsufficientStorageForLOB
| |
| <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>
| |
| <dt>InvalidVersion
| |
| <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.
| |
| <dt>InvalidInputRecordNumber
| |
| <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.
| |
| </dl>
| |
| <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.
| |
| </ul>
| |
| | |
| ==Usage Notes==
| |
| <ul>
| |
| <li><var>Reason</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.8 and later.
| |
| </ul>
| |
| | |
| ==See also==
| |
| {{Template:AddToRecordError:Reason footer}}
| |