UnicodeToEbcdic (Unicode function): Difference between revisions
Jump to navigation
Jump to search
m (syntax terms, tags and links) |
mNo edit summary |
||
| Line 12: | Line 12: | ||
<td>A <var>Unicode</var> string. </td></tr> | <td>A <var>Unicode</var> string. </td></tr> | ||
<tr><th>CharacterEncode</th> | <tr><th>CharacterEncode</th> | ||
<td>The optional (<var>[[Methods#Named parameters| | <td>The optional (<var>[[Methods#Named parameters|NameRequired]]</var>) <var class="term">CharacterEncode</var> argument is a [[Boolean enumeration|Boolean]]: <ul><li>If its value is <code>False</code>, the default, an exception is thrown if the input contains any Unicode character not translatable to EBCDIC. <li>If its value is <Code>True</code>, any Unicode character not translatable to EBCDIC is replaced with the hexadecimal character reference of the character, and the ampersand character is replaced with <code>&amp;</code>. For example, the eight characters <code>&#x201C;</code> replace the Unicode left double-quotation mark (<tt>“</tt>). </ul></td></tr> | ||
</table> | </table> | ||
| Line 25: | Line 25: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>Unless the <var class="term">CharacterEncode</var> argument is used, or you want to <code>Catch</code> a <var>CharacterTranslationException</var>, this function is generally not needed, because a <var>Unicode</var> string is implicitly converted to EBCDIC when used in an EBCDIC context. See the | <li>Unless the <var class="term">CharacterEncode</var> argument is used, or you want to <code>Catch</code> a <var>CharacterTranslationException</var>, this function is generally not needed, because a <var>Unicode</var> string is implicitly converted to EBCDIC when used in an EBCDIC context. See the example below. | ||
<li>The intrinsic <var>[[String class|String]]</var> method: <var>[[EbcdicToUnicode (String function)|EbcdicToUnicode]]</var> converts an EBCDIC string to <var>Unicode</var>. | <li>The intrinsic <var>[[String class|String]]</var> method: <var>[[EbcdicToUnicode (String function)|EbcdicToUnicode]]</var> converts an EBCDIC string to <var>Unicode</var>. | ||
<li>The <var>UnicodeToEbcdic</var> function is available as of <var class="product">[[Sirius Mods | <li>The <var>UnicodeToEbcdic</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.3. | ||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
The following example shows multiple calls of <var>UnicodeToEbcdic</var>. | |||
<p class="code">%u Unicode Initial('&#x31;':[[U (String function)|U]]) | <p class="code">%u Unicode Initial('&#x31;':[[U (String function)|U]]) | ||
Print %u:UnicodeToEbcdic | Print %u:UnicodeToEbcdic | ||
| Line 47: | Line 47: | ||
translation to EBCDIC at byte position 5 ... | translation to EBCDIC at byte position 5 ... | ||
</p> | </p> | ||
<b | <b>Note:</b> Because of the implicit conversion of <var>Unicode</var> strings (in this case to <var>String</var>), the | ||
< | <code>Print %u:UnicodeToEbcdic</code> | ||
statements in the example above could be replaced by | statements in the example above could be replaced by | ||
< | <code>Print %u</code> | ||
statements and the results would be the same. | statements and the results would be the same. | ||
==See also== | ==See also== | ||
{{Template:Unicode:UnicodeToEbcdic footer}} | {{Template:Unicode:UnicodeToEbcdic footer}} | ||
Revision as of 23:33, 28 February 2011
Translate to Ebcdic (Unicode class)
UnicodeToEbcdic converts a Unicode string to EBCDIC. Optionally, untranslatable characters can be represented with XML style hexadecimal character references.
Syntax
%string = unicode:UnicodeToEbcdic[( [CharacterEncode= boolean])] Throws CharacterTranslationException
Syntax terms
| %string | A string variable to receive the method object string translated to EBCDIC. |
|---|---|
| unicode | A Unicode string. |
| CharacterEncode | The optional (NameRequired) CharacterEncode argument is a Boolean:
|
Exceptions
This function can throw the following exception:
- CharacterTranslationException
- If the method encounters a translation problem, properties of the exception object may indicate the location and type of problem.
Usage notes
- Unless the CharacterEncode argument is used, or you want to
Catcha CharacterTranslationException, this function is generally not needed, because a Unicode string is implicitly converted to EBCDIC when used in an EBCDIC context. See the example below. - The intrinsic String method: EbcdicToUnicode converts an EBCDIC string to Unicode.
- The UnicodeToEbcdic function is available as of Sirius Mods Version 7.3.
Examples
The following example shows multiple calls of UnicodeToEbcdic.
%u Unicode Initial('1':U) Print %u:UnicodeToEbcdic %u = '1€2':U Print %u:UnicodeToEbcdic(CharacterEncode=True) Print %u:UnicodeToEbcdic
The result of the above fragment is:
1 1€2 CANCELLING REQUEST: MSIR.0751: Class STRING, function UNICODETOEBCDIC: CHARACTER TRANSLATIONEXCEPTION exception: Unicode character U+0080 without valid translation to EBCDIC at byte position 5 ...
Note: Because of the implicit conversion of Unicode strings (in this case to String), the
Print %u:UnicodeToEbcdic
statements in the example above could be replaced by
Print %u
statements and the results would be the same.