|
|
| (4 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| | | #REDIRECT [[CharacterTranslationException class#Reason property|Reason property]] |
| <span class="pageSubtitle"><section begin=dpl_desc/>TranslationExceptionReason enumeration value indicating the type of error causing the exception<section end=dpl_desc/></span>
| |
| [[Category:CharacterTranslationException methods|Reason property]] | | [[Category:CharacterTranslationException methods|Reason property]] |
| <p>
| |
| Reason is a member of the [[CharacterTranslationException class]].
| |
| </p>
| |
|
| |
| ==Syntax==
| |
| <p class="syntax">%reason = %chTransEx:Reason
| |
| </p>
| |
| ===Syntax terms===
| |
| <table class="syntaxTable">
| |
| <tr><th>%reason</th>
| |
| <td>This TranslationExceptionReason enumeration value describes the reason for the translation failure.
| |
| </td></tr>
| |
| <tr><th>%chTransEx</th>
| |
| <td>A reference to an instance of a CharacterTranslationException object.
| |
|
| |
| </td></tr></table>
| |
| ==Usage Notes==
| |
| <ul>
| |
| <li>A TranslationExceptionReason enumeration may have one of the following values:
| |
| <dl>
| |
| <dt>InvalidEncoding
| |
| <dd>An example of invalid encoding is UTF-16 string input to
| |
| <var>[[Utf16ToUnicode (String function)|Utf16ToUnicode]]</var> that contains bytes whose hexadecimal
| |
| value is D800 (which is in the surrogates range).
| |
| <dt>InvalidCharacterReference
| |
| <dd>An XML-style hexadecimal character reference (for example, <code>&#x2122;</code>
| |
| for the trademark character) may validly represent a Unicode character to
| |
| be translated.
| |
| Any other string that begins with by an ampersand (&) —
| |
| except the string <code>&amp;</code> —
| |
| might cause an exception explained by an InvalidCharacterReference enumeration.
| |
|
| |
| For example, such an exception occurs if
| |
| <var>[[EbcdicToUnicode (String function)|EbcdicToUnicode]]</var> is called, the method argument is
| |
| <code>CharacterDecode=True</code>, and the method input
| |
| contains an ampersand followed by a space.
| |
| <dt>UntranslatableCharacter
| |
| <dd>The following are examples of untranslatable characters
| |
| (with the translation tables as delivered by Sirius):
| |
| <ul>
| |
| <li>The EBCDIC input to the EbcdicToUnicode method
| |
| contains a byte whose hexadecimal value is X'FF.
| |
| <li>The Unicode input to <var>[[UnicodeToEbcdic (Unicode function)|UnicodeToEbcdic]]</var>
| |
| contains one of the many
| |
| Unicode characters that is not translated to an EBCDIC character
| |
| (for example, U+20AC, the Euro currency symbol).
| |
| </ul>
| |
| </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>
| |