EbcdicToUnicode (String function) - Revision history

JAL at 19:16, 6 November 2012

2012-11-06T19:16:15Z

← Older revision		Revision as of 19:16, 6 November 2012
Line 1:		Line 1:
	{{Template:String:EbcdicToUnicode subtitle}}		{{Template:String:EbcdicToUnicode subtitle}}

	<var>EbcdicToUnicode</var> is an [[Intrinsic classes\|intrinsic]] function that converts an EBCDIC string to Unicode using the current [[Unicode]] tables. Options are available to control:<ul><li>The conversion to the represented Unicode character of XML-style hexadecimal character references, XHTML entity references, and <code>&</code> references<li>How to handle untranslatable EBCDIC characters</ul>		<var>EbcdicToUnicode</var> is an [[Intrinsic classes\|intrinsic]] function that converts an EBCDIC string to Unicode using the current [[Unicode]] tables. Options are available to control:<ul><li>The conversion to the represented Unicode character of XML-style hexadecimal character references, XHTML entity references, and <code>&amp;</code> references<li>How to handle untranslatable EBCDIC characters</ul>

	==Syntax==		==Syntax==
Line 17:		Line 17:
	<ul>		<ul>
	<li>If its value is <var>True</var>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b>only</b> as the beginning of one of these types of character or entity reference:		<li>If its value is <var>True</var>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b>only</b> as the beginning of one of these types of character or entity reference:
	<ul><li>The substring <code>&</code>. This substring is converted to a single <code>&</code> character.		<ul>
			<li>The substring <code>&amp;</code>. This substring is converted to a single <code>&</code> character.
	<li>A hexadecimal character reference (for example, the eight characters <code>&#x201C;</code> for the Unicode <i>Left double quotation mark</i>, “). The character reference is converted to the referenced character.		<li>A hexadecimal character reference (for example, the eight characters <code>&#x201C;</code> for the Unicode <i>Left double quotation mark</i>, “). The character reference is converted to the referenced character.
	<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters <code>&copy;</code> for the <i>copyright</i> character, ©). The entity reference is converted to the referenced character.</ul>		<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters <code>&copy;</code> for the <i>copyright</i> character, ©). The entity reference is converted to the referenced character.</ul>

JALWiccan: 1 revision

2012-11-06T18:22:49Z

1 revision

← Older revision	Revision as of 18:22, 6 November 2012
(No difference)

JAL2 at 18:22, 6 November 2012

2012-11-06T18:22:37Z

← Older revision		Revision as of 18:22, 6 November 2012
Line 1:		Line 1:
	{{Template:String:EbcdicToUnicode subtitle}}		{{Template:String:EbcdicToUnicode subtitle}}

	<var>EbcdicToUnicode</var> is an [[Intrinsic classes\|intrinsic]] function that converts an EBCDIC string to Unicode using the current [[Unicode]] tables. Options are available to control:<ul><li>The conversion to the represented Unicode character of XML-style hexadecimal character references, XHTML entity references, and <code>&~~amp;amp;~~</code> references<li>How to handle untranslatable EBCDIC characters</ul>		<var>EbcdicToUnicode</var> is an [[Intrinsic classes\|intrinsic]] function that converts an EBCDIC string to Unicode using the current [[Unicode]] tables. Options are available to control:<ul><li>The conversion to the represented Unicode character of XML-style hexadecimal character references, XHTML entity references, and <code>&</code> references<li>How to handle untranslatable EBCDIC characters</ul>

	==Syntax==		==Syntax==
Line 17:		Line 17:
	<ul>		<ul>
	<li>If its value is <var>True</var>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b>only</b> as the beginning of one of these types of character or entity reference:		<li>If its value is <var>True</var>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b>only</b> as the beginning of one of these types of character or entity reference:
	<ul><li>The substring <code>&~~amp;amp;~~</code>. This substring is converted to a single <code>&</code> character.		<ul><li>The substring <code>&</code>. This substring is converted to a single <code>&</code> character.
	<li>A hexadecimal character reference (for example, the eight characters <code>&#x201C;</code> for the Unicode <i>Left double quotation mark</i>, “). The character reference is converted to the referenced character.		<li>A hexadecimal character reference (for example, the eight characters <code>&#x201C;</code> for the Unicode <i>Left double quotation mark</i>, “). The character reference is converted to the referenced character.
	<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters <code>&copy;</code> for the <i>copyright</i> character, ©). The entity reference is converted to the referenced character.</ul>		<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters <code>&copy;</code> for the <i>copyright</i> character, ©). The entity reference is converted to the referenced character.</ul>

JAL2 at 21:08, 7 August 2012

2012-08-07T21:08:06Z

← Older revision		Revision as of 21:08, 7 August 2012
Line 9:		Line 9:
	<tr><th>%unicode</th>		<tr><th>%unicode</th>
	<td>A <var>Unicode</var> variable to receive the method object <var class="term">string</var> translated to Unicode.</td></tr>		<td>A <var>Unicode</var> variable to receive the method object <var class="term">string</var> translated to Unicode.</td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>An EBCDIC character string.</td></tr>		<td>An EBCDIC character string.</td></tr>

	<tr><th><var>CharacterDecode</var></th>		<tr><th><var>CharacterDecode</var></th>
	<td>The optional, [[Notation conventions for methods#Named parameters\|name required]], argument <var>CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:		<td>The optional, [[Notation conventions for methods#Named parameters\|name required]], argument <var>CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:
Line 27:		Line 29:
	<li>If the value is the null string, any untranslatable EBCDIC characters are removed from the input string.		<li>If the value is the null string, any untranslatable EBCDIC characters are removed from the input string.
	</ul>		</ul>
	The <var>Untranslatable</var> parameter is optional. If it is omitted and an EBCDIC character is encountered that is not translatable to Unicode, a <var>[[CharacterTranslationException class\|CharacterTranslationException]]</var> exception is thrown.<p>The <var ~~class="term"~~>Untranslatable</var> parameter is available as of <var class="product">Sirius Mods</var> version 7.5. It provides the functionality formerly provided by the <var>EbcdicTranslateNonUnicode</var> and the <var>EbcdicRemoveNonUnicode</var> methods, which are invalid as of <var class="product">Sirius Mods</var> 7.5.</p></td></tr>		The <var>Untranslatable</var> parameter is optional. If it is omitted and an EBCDIC character is encountered that is not translatable to Unicode, a <var>[[CharacterTranslationException class\|CharacterTranslationException]]</var> exception is thrown.<p>The <var>Untranslatable</var> parameter is available as of <var class="product">Sirius Mods</var> version 7.5. It provides the functionality formerly provided by the <var>EbcdicTranslateNonUnicode</var> and the <var>EbcdicRemoveNonUnicode</var> methods, which are invalid as of <var class="product">Sirius Mods</var> 7.5.</p></td></tr>
	</table>		</table>

Line 38:		Line 40:

	==Usage notes==		==Usage notes==
	<ul><li>Using <var>EbcdicToUnicode</var> with <code>CharacterDecode=True</code> (or using the <var>[[U (String function)\|U]]</var> function) is necessary if the string you want to convert to Unicode may contain a hexadecimal or XHTML entity character reference which you want converted to the corresponding Unicode character.		<ul>
	<li><var>EbcdicToUnicode</var> is available as of <var class="product">Sirius Mods</var> version 7.3.</ul>		<li>Using <var>EbcdicToUnicode</var> with <code>CharacterDecode=True</code> (or using the <var>[[U (String function)\|U]]</var> function) is necessary if the string you want to convert to Unicode may contain a hexadecimal or XHTML entity character reference which you want converted to the corresponding Unicode character.
			<li><var>EbcdicToUnicode</var> is available as of <var class="product">Sirius Mods</var> version 7.3.
			</ul>

	==Examples==		==Examples==

JAL2: /* Syntax terms */

2012-06-10T22:31:53Z

Syntax terms

← Older revision		Revision as of 22:31, 10 June 2012
Line 12:		Line 12:
	<td>An EBCDIC character string.</td></tr>		<td>An EBCDIC character string.</td></tr>
	<tr><th><var>CharacterDecode</var></th>		<tr><th><var>CharacterDecode</var></th>
	<td>The optional, ~~but~~ [[Notation conventions for methods#Named parameters\|name required]], argument <var>CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:		<td>The optional, [[Notation conventions for methods#Named parameters\|name required]], argument <var>CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:
	<ul>		<ul>
	<li>If its value is <var>True</var>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b>only</b> as the beginning of one of these types of character or entity reference:		<li>If its value is <var>True</var>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b>only</b> as the beginning of one of these types of character or entity reference:

JALWiccan: 1 revision

2012-06-10T22:26:00Z

1 revision

← Older revision	Revision as of 22:26, 10 June 2012
(No difference)

JAL2 at 22:25, 10 June 2012

2012-06-10T22:25:59Z

← Older revision		Revision as of 22:25, 10 June 2012
Line 22:		Line 22:
	</ul></td></tr>		</ul></td></tr>
	<tr><th><var>Untranslatable</var></th>		<tr><th><var>Untranslatable</var></th>
	<td>The optional, ~~but~~ name required, argument <var>Untranslatable</var> is a single character or a null string that specifies how to handle EBCDIC input characters that are not translatable to Unicode:		<td>The optional, name required, argument <var>Untranslatable</var> is a single character or a null string that specifies how to handle EBCDIC input characters that are not translatable to Unicode:
	<ul>		<ul>
	<li>If the value is a single Unicode character, any untranslatable EBCDIC characters are replaced with that Unicode character.		<li>If the value is a single Unicode character, any untranslatable EBCDIC characters are replaced with that Unicode character.

JAL2 at 20:20, 1 December 2011

2011-12-01T20:20:25Z

← Older revision		Revision as of 20:20, 1 December 2011
Line 1:		Line 1:
	{{Template:String:EbcdicToUnicode subtitle}}		{{Template:String:EbcdicToUnicode subtitle}}

	<var>EbcdicToUnicode</var> is an [[Intrinsic classes\|intrinsic]] function that converts an EBCDIC string to Unicode using the current [[Unicode]] tables. Options are available to control:<ul><li>the ~~conversion~~ of XML style hexadecimal character references, XHTML entity references, and ~~''''~~&amp;~~amp;''''~~ references ~~to the represented Unicode character;~~<li>~~how~~ to handle untranslatable EBCDIC characters</ul>		<var>EbcdicToUnicode</var> is an [[Intrinsic classes\|intrinsic]] function that converts an EBCDIC string to Unicode using the current [[Unicode]] tables. Options are available to control:<ul><li>The conversion to the represented Unicode character of XML-style hexadecimal character references, XHTML entity references, and <code>&amp;</code> references<li>How to handle untranslatable EBCDIC characters</ul>

	==Syntax==		==Syntax==
Line 12:		Line 12:
	<td>An EBCDIC character string.</td></tr>		<td>An EBCDIC character string.</td></tr>
	<tr><th><var>CharacterDecode</var></th>		<tr><th><var>CharacterDecode</var></th>
	<td>The optional, but ~~<var class="term">NameRequired</var>~~, argument <var ~~class="term"~~>CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:		<td>The optional, but [[Notation conventions for methods#Named parameters\|name required]], argument <var>CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:
	<ul><li>If its value is <~~code~~>True</~~code~~>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b~~><i~~>only~~</i>~~</b> as the beginning of one of these types of character or entity reference:<ul><li>The substring ~~''''~~&amp;~~amp;''''~~. This substring is converted to a single ~~''''~~&~~''''~~ character.<li>A hexadecimal character reference (for example, the eight characters '&~~amp;~~amp;#x201C;' for the Unicode <i>Left double quotation mark</i> ~~<code>'~~&~~amp;~~#x201C;~~'</code>~~). The character reference is converted to the referenced character.<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters '&~~amp;~~amp;copy;' for the <i>copyright</i> character ~~<code>'~~&~~amp;~~copy;~~'</code>~~). The entity reference is converted to the referenced character.</ul><p> A decimal character reference (for example, &~~amp;~~amp;#172;) is <b~~><i~~>not~~</i>~~</b> allowed.</p>		<ul>
	<li>If its value is <~~code~~>False</~~code~~>, the default, an ampersand is treated only as a normal character.</ul></td></tr>		<li>If its value is <var>True</var>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b>only</b> as the beginning of one of these types of character or entity reference:
			<ul><li>The substring <code>&amp;</code>. This substring is converted to a single <code>&</code> character.
			<li>A hexadecimal character reference (for example, the eight characters <code>&#x201C;</code> for the Unicode <i>Left double quotation mark</i>, “). The character reference is converted to the referenced character.
			<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters <code>&copy;</code> for the <i>copyright</i> character, ©). The entity reference is converted to the referenced character.</ul>
			<p> A decimal character reference (for example, <code>&#172;</code>) is <b>not</b> allowed.</p>
			<li>If its value is <var>False</var>, the default, an ampersand is treated only as a normal character.
			</ul></td></tr>
	<tr><th><var>Untranslatable</var></th>		<tr><th><var>Untranslatable</var></th>
	<td>The optional, but ~~<var class="term">NameRequired</var>~~, argument <var ~~class="term"~~>Untranslatable</var> is a single character or a null string that specifies how to handle EBCDIC input characters that are not translatable to Unicode:<ul><li>If the value is a single Unicode character, any untranslatable EBCDIC characters are replaced with that Unicode character.<li>If the value is the null string, any untranslatable EBCDIC characters are removed from the input string.</ul>The <var ~~class="term"~~>Untranslatable</var> parameter is optional. If it is omitted and an EBCDIC character is encountered that is not translatable to Unicode, a <var>[[CharacterTranslationException class\|CharacterTranslationException]]</var> exception is thrown.<p>The <var class="term">Untranslatable</var> parameter is available as of <var class="product">Sirius Mods</var> version 7.5. It provides the functionality formerly provided by the <var>EbcdicTranslateNonUnicode</var> and the <var>EbcdicRemoveNonUnicode</var> methods, which are invalid as of <var class="product">Sirius Mods</var> 7.5.</p></td></tr>		<td>The optional, but name required, argument <var>Untranslatable</var> is a single character or a null string that specifies how to handle EBCDIC input characters that are not translatable to Unicode:
			<ul>
			<li>If the value is a single Unicode character, any untranslatable EBCDIC characters are replaced with that Unicode character.
			<li>If the value is the null string, any untranslatable EBCDIC characters are removed from the input string.
			</ul>
			The <var>Untranslatable</var> parameter is optional. If it is omitted and an EBCDIC character is encountered that is not translatable to Unicode, a <var>[[CharacterTranslationException class\|CharacterTranslationException]]</var> exception is thrown.<p>The <var class="term">Untranslatable</var> parameter is available as of <var class="product">Sirius Mods</var> version 7.5. It provides the functionality formerly provided by the <var>EbcdicTranslateNonUnicode</var> and the <var>EbcdicRemoveNonUnicode</var> methods, which are invalid as of <var class="product">Sirius Mods</var> 7.5.</p></td></tr>
	</table>		</table>

Line 28:		Line 39:
	==Usage notes==		==Usage notes==
	<ul><li>Using <var>EbcdicToUnicode</var> with <code>CharacterDecode=True</code> (or using the <var>[[U (String function)\|U]]</var> function) is necessary if the string you want to convert to Unicode may contain a hexadecimal or XHTML entity character reference which you want converted to the corresponding Unicode character.		<ul><li>Using <var>EbcdicToUnicode</var> with <code>CharacterDecode=True</code> (or using the <var>[[U (String function)\|U]]</var> function) is necessary if the string you want to convert to Unicode may contain a hexadecimal or XHTML entity character reference which you want converted to the corresponding Unicode character.
	<li><var>EbcdicToUnicode</var> is available as of <var class="product">Sirius Mods</var>version 7.3.</ul>		<li><var>EbcdicToUnicode</var> is available as of <var class="product">Sirius Mods</var> version 7.3.</ul>

	==Examples==		==Examples==
	~~<ol><li>~~The following fragment shows four calls of <var>EbcdicToUnicode</var>: respectively against translatable EBCDIC characters, a string with a character reference, a string with an entity reference, and a string with an EBCDIC character that cannot be translated to Unicode. The <var>[[X (String function)\|X]]</var> constant function is used in the example.		The following fragment shows four calls of <var>EbcdicToUnicode</var>: respectively against translatable EBCDIC characters, a string with a character reference, a string with an entity reference, and a string with an EBCDIC character that cannot be translated to Unicode. The <var>[[X (String function)\|X]]</var> constant function is used in the example.
	<p class="code">%e string Len 20		<p class="code">%e string Len 20
	%u unicode		%u unicode
Line 39:		Line 50:
	Print %u:UnicodeToUtf16:StringToHex		Print %u:UnicodeToUtf16:StringToHex

	%e = '1&~~amp;~~amp;#x2122;2'		%e = '1&#x2122;2'
	%u = %e:EbcdicToUnicode(CharacterDecode=True)		%u = %e:EbcdicToUnicode(CharacterDecode=True)
	Print %u:UnicodeToUtf16:StringToHex		Print %u:UnicodeToUtf16:StringToHex

	%e = '&~~amp;~~amp;copy;'		%e = '&copy;'
	%u = %e:EbcdicToUnicode(CharacterDecode=True)		%u = %e:EbcdicToUnicode(CharacterDecode=True)
	Print %u		Print %u
Line 55:		Line 66:
	00310032		00310032
	003121220032		003121220032
	&~~amp;~~copy;		©
	CANCELLING REQUEST: MSIR.0751: Class STRING, function		CANCELLING REQUEST: MSIR.0751: Class STRING, function EBCDICTOUNICODE: CHARACTER TRANSLATIONEXCEPTION
	EBCDICTOUNICODE: CHARACTER TRANSLATIONEXCEPTION		exception: EBCDIC character X'FF' without valid translation to Unicode at byte position 2 ...
	exception: EBCDIC character X'FF' without valid
	translation to Unicode at byte position 2 ...
	</p><p>		</p><p>
	<b~~><i~~>Note:~~</i>~~</b> The initial <code>Print %u</code> statement in the example above is not very revealing because it is equivalent to specifying <code>Print %u:[[UnicodeToEbcdic (Unicode function)\|UnicodeToEbcdic]]</code> &~~amp;~~mdash; a <var>Unicode</var> string is implicitly converted to EBCDIC when it is used in an EBCDIC context like a Print statement. <var>[[UnicodeToUtf16 (Unicode function)\|UnicodeToUtf16]]</var>, however, converts the <var>Unicode</var> variable to a byte-stream string, which <var>[[StringToHex (String function)\|StringToHex]]</var> converts to its hex representation.</p~~></ol~~>		<b>Note:</b> The initial <code>Print %u</code> statement in the example above is not very revealing because it is equivalent to specifying <code>Print %u:[[UnicodeToEbcdic (Unicode function)\|UnicodeToEbcdic]]</code> — a <var>Unicode</var> string is implicitly converted to EBCDIC when it is used in an EBCDIC context like a Print statement. <var>[[UnicodeToUtf16 (Unicode function)\|UnicodeToUtf16]]</var>, however, converts the <var>Unicode</var> variable to a byte-stream string, which <var>[[StringToHex (String function)\|StringToHex]]</var> converts to its hex representation.</p>

	==See also==		==See also==

JALWiccan: 1 revision

2011-04-13T00:21:18Z

1 revision

← Older revision	Revision as of 00:21, 13 April 2011
(No difference)

JAL: /* Syntax terms */

2011-04-13T00:21:16Z

Syntax terms

← Older revision		Revision as of 00:21, 13 April 2011
Line 1:		Line 1:
	{{Template:String:EbcdicToUnicode subtitle}}		{{Template:String:EbcdicToUnicode subtitle}}

	<var>EbcdicToUnicode</var> is an [[Intrinsic classes\|intrinsic]] function that converts an EBCDIC string to Unicode using the current [[Unicode]] tables. Options are available to control:<ul><li>the conversion of XML style hexadecimal character references, XHTML entity references, and ''''&amp;'''' references to the represented Unicode character;<li>how to handle untranslatable EBCDIC characters</ul>		<var>EbcdicToUnicode</var> is an [[Intrinsic classes\|intrinsic]] function that converts an EBCDIC string to Unicode using the current [[Unicode]] tables. Options are available to control:<ul><li>the conversion of XML style hexadecimal character references, XHTML entity references, and ''''&amp;amp;'''' references to the represented Unicode character;<li>how to handle untranslatable EBCDIC characters</ul>

	==Syntax==		==Syntax==
Line 11:		Line 11:
	<tr><th>string</th>		<tr><th>string</th>
	<td>An EBCDIC character string.</td></tr>		<td>An EBCDIC character string.</td></tr>
	<tr><th>CharacterDecode</th>		<tr><th><var>CharacterDecode</var></th>
	<td>The optional, but <var class="term">NameRequired</var>, argument <var class="term">CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:		<td>The optional, but <var class="term">NameRequired</var>, argument <var class="term">CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:
	<ul><li>If its value is <code>True</code>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b><i>only</i></b> as the beginning of one of these types of character or entity reference:<ul><li>The substring ''''&amp;''''. This substring is converted to a single ''''&'''' character.<li>A hexadecimal character reference (for example, the eight characters '&#x201C;' for the Unicode <i>Left double quotation mark</i> <code>'“'</code>). The character reference is converted to the referenced character.<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters '&copy;' for the <i>copyright</i> character <code>'©'</code>). The entity reference is converted to the referenced character.</ul><p> A decimal character reference (for example, &#172;) is <b><i>not</i></b> allowed.</p>		<ul><li>If its value is <code>True</code>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b><i>only</i></b> as the beginning of one of these types of character or entity reference:<ul><li>The substring ''''&amp;amp;''''. This substring is converted to a single ''''&'''' character.<li>A hexadecimal character reference (for example, the eight characters '&amp;#x201C;' for the Unicode <i>Left double quotation mark</i> <code>'&#x201C;'</code>). The character reference is converted to the referenced character.<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters '&amp;copy;' for the <i>copyright</i> character <code>'&copy;'</code>). The entity reference is converted to the referenced character.</ul><p> A decimal character reference (for example, &amp;#172;) is <b><i>not</i></b> allowed.</p>
	<li>If its value is <code>False</code>, the default, an ampersand is treated only as a normal character.</ul></td></tr>		<li>If its value is <code>False</code>, the default, an ampersand is treated only as a normal character.</ul></td></tr>
	<tr><th>Untranslatable</th>		<tr><th><var>Untranslatable</var></th>
	<td>The optional, but <var class="term">NameRequired</var>, argument <var class="term">Untranslatable</var> is a single character or a null string that specifies how to handle EBCDIC input characters that are not translatable to Unicode:<ul><li>If the value is a single Unicode character, any untranslatable EBCDIC characters are replaced with that Unicode character.<li>If the value is the null string, any untranslatable EBCDIC characters are removed from the input string.</ul>The <var class="term">Untranslatable</var> parameter is optional. If it is omitted and an EBCDIC character is encountered that is not translatable to Unicode, a <var>[[CharacterTranslationException class\|CharacterTranslationException]]</var> exception is thrown.<p>The <var class="term">Untranslatable</var> parameter is available as of <var class="product">Sirius Mods</var> version 7.5. It provides the functionality formerly provided by the <var>EbcdicTranslateNonUnicode</var> and the <var>EbcdicRemoveNonUnicode</var> methods, which are invalid as of <var class="product">Sirius Mods</var> 7.5.</p></td></tr>		<td>The optional, but <var class="term">NameRequired</var>, argument <var class="term">Untranslatable</var> is a single character or a null string that specifies how to handle EBCDIC input characters that are not translatable to Unicode:<ul><li>If the value is a single Unicode character, any untranslatable EBCDIC characters are replaced with that Unicode character.<li>If the value is the null string, any untranslatable EBCDIC characters are removed from the input string.</ul>The <var class="term">Untranslatable</var> parameter is optional. If it is omitted and an EBCDIC character is encountered that is not translatable to Unicode, a <var>[[CharacterTranslationException class\|CharacterTranslationException]]</var> exception is thrown.<p>The <var class="term">Untranslatable</var> parameter is available as of <var class="product">Sirius Mods</var> version 7.5. It provides the functionality formerly provided by the <var>EbcdicTranslateNonUnicode</var> and the <var>EbcdicRemoveNonUnicode</var> methods, which are invalid as of <var class="product">Sirius Mods</var> 7.5.</p></td></tr>
	</table>		</table>
Line 39:		Line 39:
	Print %u:UnicodeToUtf16:StringToHex		Print %u:UnicodeToUtf16:StringToHex

	%e = '1&#x2122;2'		%e = '1&amp;#x2122;2'
	%u = %e:EbcdicToUnicode(CharacterDecode=True)		%u = %e:EbcdicToUnicode(CharacterDecode=True)
	Print %u:UnicodeToUtf16:StringToHex		Print %u:UnicodeToUtf16:StringToHex

	%e = '&copy;'		%e = '&amp;copy;'
	%u = %e:EbcdicToUnicode(CharacterDecode=True)		%u = %e:EbcdicToUnicode(CharacterDecode=True)
	Print %u		Print %u
Line 55:		Line 55:
	00310032		00310032
	003121220032		003121220032
	©		&copy;
	CANCELLING REQUEST: MSIR.0751: Class STRING, function		CANCELLING REQUEST: MSIR.0751: Class STRING, function
	EBCDICTOUNICODE: CHARACTER TRANSLATIONEXCEPTION		EBCDICTOUNICODE: CHARACTER TRANSLATIONEXCEPTION
Line 61:		Line 61:
	translation to Unicode at byte position 2 ...		translation to Unicode at byte position 2 ...
	</p><p>		</p><p>
	<b><i>Note:</i></b> The initial <code>Print %u</code> statement in the example above is not very revealing because it is equivalent to specifying <code>Print %u:[[UnicodeToEbcdic (Unicode function)\|UnicodeToEbcdic]]</code> — a <var>Unicode</var> string is implicitly converted to EBCDIC when it is used in an EBCDIC context like a Print statement. <var>[[UnicodeToUtf16 (Unicode function)\|UnicodeToUtf16]]</var>, however, converts the <var>Unicode</var> variable to a byte-stream string, which <var>[[StringToHex (String function)\|StringToHex]]</var> converts to its hex representation.</p></ol>		<b><i>Note:</i></b> The initial <code>Print %u</code> statement in the example above is not very revealing because it is equivalent to specifying <code>Print %u:[[UnicodeToEbcdic (Unicode function)\|UnicodeToEbcdic]]</code> &mdash; a <var>Unicode</var> string is implicitly converted to EBCDIC when it is used in an EBCDIC context like a Print statement. <var>[[UnicodeToUtf16 (Unicode function)\|UnicodeToUtf16]]</var>, however, converts the <var>Unicode</var> variable to a byte-stream string, which <var>[[StringToHex (String function)\|StringToHex]]</var> converts to its hex representation.</p></ol>

	==See also==		==See also==