Reason (CharacterTranslationException property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
{{Template:CharacterTranslationException:Reason subtitle}}
#REDIRECT [[CharacterTranslationException class#Reason property|Reason property]]
==Syntax==
[[Category:CharacterTranslationException methods|Reason property]]
{{Template:CharacterTranslationException:Reason syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%translationExceptionReason</th>
<td>This <var>TranslationExceptionReason</var> enumeration value describes the reason for the translation failure.
</td></tr>
<tr><th>characterTranslationException</th>
<td>A reference to an instance of a <var>[[CharacterTranslationException_class|CharacterTranslationException]]</var> object.
</td></tr></table>
 
==Usage notes==
<ul>
<li>A <var>TranslationExceptionReason</var> 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>&amp;amp;#x2122;</code> for the trademark character) may validly represent a [[Unicode]] character to be translated.  Any other string that begins with by an ampersand (&amp;) &amp;mdash; except the string <code>&amp;amp;amp;</code> &amp;mdash; might cause an exception explained by an <var class="term">InvalidCharacterReference</var> enumeration.
<p>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.</p>
<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 <var>[[EbcdicToUnicode_(String_function)|EbcdicToUnicode]]</var> 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>
 
==See also==
{{Template:CharacterTranslationException:Reason footer}}

Latest revision as of 23:07, 9 May 2011