UnicodeToEbcdic (Unicode function) - Revision history

JAL: /* Usage notes */

2012-11-06T20:03:02Z

Usage notes

← Older revision		Revision as of 20:03, 6 November 2012
Line 29:		Line 29:
	==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 following [[#Examples\|example]].		<li>Unless the <var>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 following [[#Examples\|example]].
	<li>The <var>UnicodeToEbcdic</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.3.		<li>The <var>UnicodeToEbcdic</var> function is available as of <var class="product">Sirius Mods</var> Version 7.3.
	</ul>		</ul>

JAL: /* Syntax terms */

2012-11-06T20:02:16Z

Syntax terms

← Older revision		Revision as of 20:02, 6 November 2012
Line 16:		Line 16:
	<td>The optional ([[Notation conventions for methods#Named parameters\|name required]]) <var>CharacterEncode</var> argument is a <var>[[Boolean enumeration]]</var>:		<td>The optional ([[Notation conventions for methods#Named parameters\|name required]]) <var>CharacterEncode</var> argument is a <var>[[Boolean enumeration]]</var>:
	<ul>		<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>&</code>. For example, the eight characters <code>&#x201C;</code> replace the Unicode left double-quotation mark (<tt>&#X201C;</tt>).		<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>&#X201C;</tt>).
	</ul></td></tr>		</ul></td></tr>
	</table>		</table>

JAL: /* Examples */

2012-11-06T20:01:38Z

Examples

← Older revision		Revision as of 20:01, 6 November 2012
Line 35:		Line 35:
	==Examples==		==Examples==
	The following example shows multiple calls of <var>UnicodeToEbcdic</var>.		The following example shows multiple calls of <var>UnicodeToEbcdic</var>.
	<p class="code">%u Unicode Initial('1':[[U (String function)\|U]])		<p class="code">%u Unicode Initial('&#x31;':[[U (String function)\|U]])
	print %u:UnicodeToEbcdic		print %u:UnicodeToEbcdic

	%u = '12':U		%u = '1&#x80;2':U
	print %u:UnicodeToEbcdic(CharacterEncode=True)		print %u:UnicodeToEbcdic(CharacterEncode=True)
	print %u:UnicodeToEbcdic		print %u:UnicodeToEbcdic
Line 44:		Line 44:
	The result of the above fragment is:		The result of the above fragment is:
	<p class="output">1		<p class="output">1
	12		1&#x0080;2
	CANCELLING REQUEST: MSIR.0751: Class STRING, function		CANCELLING REQUEST: MSIR.0751: Class STRING, function
	UNICODETOEBCDIC: CHARACTER TRANSLATIONEXCEPTION		UNICODETOEBCDIC: CHARACTER TRANSLATIONEXCEPTION

JALWiccan: 1 revision

2012-11-06T17:32:26Z

1 revision

← Older revision	Revision as of 17:32, 6 November 2012
(No difference)

JAL2 at 17:32, 6 November 2012

2012-11-06T17:32:25Z

← Older revision		Revision as of 17:32, 6 November 2012
Line 16:		Line 16:
	<td>The optional ([[Notation conventions for methods#Named parameters\|name required]]) <var>CharacterEncode</var> argument is a <var>[[Boolean enumeration]]</var>:		<td>The optional ([[Notation conventions for methods#Named parameters\|name required]]) <var>CharacterEncode</var> argument is a <var>[[Boolean enumeration]]</var>:
	<ul>		<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;amp;~~</code>. For example, the eight characters <code>&#x201C;</code> replace the Unicode left double-quotation mark (<tt>&#X201C;</tt>).		<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>&</code>. For example, the eight characters <code>&#x201C;</code> replace the Unicode left double-quotation mark (<tt>&#X201C;</tt>).
	</ul></td></tr>		</ul></td></tr>
	</table>		</table>
Line 35:		Line 35:
	==Examples==		==Examples==
	The following example shows multiple calls of <var>UnicodeToEbcdic</var>.		The following example shows multiple calls of <var>UnicodeToEbcdic</var>.
	<p class="code">%u Unicode Initial('&~~amp;amp;~~#x31;':[[U (String function)\|U]])		<p class="code">%u Unicode Initial('1':[[U (String function)\|U]])
	print %u:UnicodeToEbcdic		print %u:UnicodeToEbcdic

	%u = '1&~~amp;amp;~~#x80;2':U		%u = '12':U
	print %u:UnicodeToEbcdic(CharacterEncode=True)		print %u:UnicodeToEbcdic(CharacterEncode=True)
	print %u:UnicodeToEbcdic		print %u:UnicodeToEbcdic
Line 44:		Line 44:
	The result of the above fragment is:		The result of the above fragment is:
	<p class="output">1		<p class="output">1
	1&~~amp;amp;~~#x0080;2		12
	CANCELLING REQUEST: MSIR.0751: Class STRING, function		CANCELLING REQUEST: MSIR.0751: Class STRING, function
	UNICODETOEBCDIC: CHARACTER TRANSLATIONEXCEPTION		UNICODETOEBCDIC: CHARACTER TRANSLATIONEXCEPTION

JAL2 at 22:15, 7 August 2012

2012-08-07T22:15:20Z

← Older revision		Revision as of 22:15, 7 August 2012
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:Unicode:UnicodeToEbcdic syntax}}		{{Template:Unicode:UnicodeToEbcdic syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string variable to receive the method object string translated to EBCDIC.</td></tr>		<td>A string variable to receive the method object string translated to EBCDIC.</td></tr>

	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string to be translated.</td></tr>		<td>A <var>Unicode</var> string to be translated.</td></tr>

	<tr><th><var>CharacterEncode</var></th>		<tr><th><var>CharacterEncode</var></th>
	<td>The optional (~~<var>~~[[~~Methods~~#Named parameters\|~~NameRequired~~]]~~</var>~~) <var ~~class="term"~~>CharacterEncode</var> argument is a [[Boolean enumeration]]:<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;~~amp;amp;</code>. For example, the eight characters <code>&~~amp;~~amp;#x201C;</code> replace the Unicode left double-quotation mark (<tt>&~~amp;~~#X201C;</tt>). </ul></td></tr>		<td>The optional ([[Notation conventions for methods#Named parameters\|name required]]) <var>CharacterEncode</var> argument is a <var>[[Boolean enumeration]]</var>:
			<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>&#X201C;</tt>).
			</ul></td></tr>
	</table>		</table>

Line 28:		Line 34:

	==Examples==		==Examples==
	~~<ol><li>~~
	The following example shows multiple calls of <var>UnicodeToEbcdic</var>.		The following example shows multiple calls of <var>UnicodeToEbcdic</var>.
	<p class="code">%u Unicode Initial('&amp;#x31;':[[U (String function)\|U]])		<p class="code">%u Unicode Initial('&amp;#x31;':[[U (String function)\|U]])
Line 47:		Line 52:
	<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		<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
	<code>Print %u</code> statements and the results would be the same.		<code>Print %u</code> statements and the results would be the same.
	~~</ol>~~

	==See also==		==See also==
	<ul><li>The intrinsic <var>[[String class\|String]]</var> method: <var>[[EbcdicToUnicode (String function)\|EbcdicToUnicode]]</var> converts an EBCDIC string to <var>Unicode</var>.</ul>		<ul>
			<li>The intrinsic <var>[[String class\|String]]</var> method: <var>[[EbcdicToUnicode (String function)\|EbcdicToUnicode]]</var> converts an EBCDIC string to <var>Unicode</var>.
			</ul>
	{{Template:Unicode:UnicodeToEbcdic footer}}		{{Template:Unicode:UnicodeToEbcdic footer}}

JALWiccan: 1 revision

2011-04-13T00:55:35Z

1 revision

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

Goff: tags and edits

2011-04-13T00:55:35Z

tags and edits

← Older revision		Revision as of 00:55, 13 April 2011
Line 10:		Line 10:
	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string to be translated.</td></tr>		<td>A <var>Unicode</var> string to be translated.</td></tr>
	<tr><th>CharacterEncode</th>		<tr><th><var>CharacterEncode</var></th>
	<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var class="term">CharacterEncode</var> argument is a [[Boolean enumeration]]:<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>&#X201C;</tt>). </ul></td></tr>		<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var class="term">CharacterEncode</var> argument is a [[Boolean enumeration]]:<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;amp;</code>. For example, the eight characters <code>&amp;#x201C;</code> replace the Unicode left double-quotation mark (<tt>&#X201C;</tt>). </ul></td></tr>
	</table>		</table>

Line 30:		Line 30:
	<ol><li>		<ol><li>
	The following example shows multiple calls of <var>UnicodeToEbcdic</var>.		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('&amp;#x31;':[[U (String function)\|U]])
	print %u:UnicodeToEbcdic		print %u:UnicodeToEbcdic

	%u = '1&#x80;2':U		%u = '1&amp;#x80;2':U
	print %u:UnicodeToEbcdic(CharacterEncode=True)		print %u:UnicodeToEbcdic(CharacterEncode=True)
	print %u:UnicodeToEbcdic		print %u:UnicodeToEbcdic
Line 39:		Line 39:
	The result of the above fragment is:		The result of the above fragment is:
	<p class="output">1		<p class="output">1
	1&#x0080;2		1&amp;#x0080;2
	CANCELLING REQUEST: MSIR.0751: Class STRING, function		CANCELLING REQUEST: MSIR.0751: Class STRING, function
	UNICODETOEBCDIC: CHARACTER TRANSLATIONEXCEPTION		UNICODETOEBCDIC: CHARACTER TRANSLATIONEXCEPTION

Goff: tags and edits

2011-03-14T00:43:07Z

tags and edits

← Older revision		Revision as of 00:43, 14 March 2011
Line 1:		Line 1:
	{{Template:Unicode:UnicodeToEbcdic subtitle}}		{{Template:Unicode:UnicodeToEbcdic subtitle}}

	<var>UnicodeToEbcdic</var> converts a <var>Unicode</var> string to EBCDIC. Optionally, untranslatable characters can be represented with XML style hexadecimal character references.		<var>UnicodeToEbcdic</var> converts a <var>Unicode</var> string to EBCDIC. Optionally, untranslatable characters can be represented with XML style hexadecimal character references.

Line 10:		Line 9:
	<td>A string variable to receive the method object string translated to EBCDIC.</td></tr>		<td>A string variable to receive the method object string translated to EBCDIC.</td></tr>
	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string to be translated.</td></tr>
	<tr><th>CharacterEncode</th>		<tr><th>CharacterEncode</th>
	<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>&#X201C;</tt>). </ul></td></tr>		<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var class="term">CharacterEncode</var> argument is a [[Boolean enumeration]]:<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>&#X201C;</tt>). </ul></td></tr>
	</table>		</table>

Line 19:		Line 18:
	<dl>		<dl>
	<dt><var>[[CharacterTranslationException class\|CharacterTranslationException]]</var>		<dt><var>[[CharacterTranslationException class\|CharacterTranslationException]]</var>
	<dd>If the method encounters a translation problem,		<dd>If the method encounters a translation problem, properties of the exception object may indicate the location and type of problem.
	properties of the exception object may indicate the location and type of problem.
	</dl>		</dl>

	==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 ~~example below.~~		<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 following [[#Examples\|example]].
	~~<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]]</var> Version 7.3.		<li>The <var>UnicodeToEbcdic</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.3.
	</ul>		</ul>

	==Examples==		==Examples==
			<ol><li>
	The following example shows multiple calls of <var>UnicodeToEbcdic</var>.		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

	%u = '1&#x80;2':U		%u = '1&#x80;2':U
	~~Print~~ %u:UnicodeToEbcdic(CharacterEncode=True)		print %u:UnicodeToEbcdic(CharacterEncode=True)
	~~Print~~ %u:UnicodeToEbcdic		print %u:UnicodeToEbcdic
	</p>		</p>
	The result of the above fragment is:		The result of the above fragment is:
Line 47:		Line 45:
	translation to EBCDIC at byte position 5 ...		translation to EBCDIC at byte position 5 ...
	</p>		</p>
	<b>Note:</b> Because of the implicit conversion of <var>Unicode</var> strings (in this case to <var>String</var>), the		<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
	<code>Print %u:UnicodeToEbcdic</code>		<code>Print %u</code> statements and the results would be the same.
	statements in the example above could be replaced by		</ol>
	<code>Print %u</code>
	statements and the results would be the same.

	==See also==		==See also==
			<ul><li>The intrinsic <var>[[String class\|String]]</var> method: <var>[[EbcdicToUnicode (String function)\|EbcdicToUnicode]]</var> converts an EBCDIC string to <var>Unicode</var>.</ul>
	{{Template:Unicode:UnicodeToEbcdic footer}}		{{Template:Unicode:UnicodeToEbcdic footer}}

JAL at 23:33, 28 February 2011

2011-02-28T23:33:36Z

← Older revision		Revision as of 23:33, 28 February 2011
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\|~~Name-Required~~]]</var>) <var class="term">CharacterEncode</var> argument is a Boolean: <ul><li>If its value is <code>False</code>, the default, an exception is thrown if the input contains any ~~<var>~~Unicode~~</var>~~ character not translatable to EBCDIC. <li>If its value is <Code>True</code>, any ~~<var>~~Unicode~~</var>~~ 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." (<~~code~~>&#X201C;</~~code~~>) </ul></td></tr>		<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>&#X201C;</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 ~~following examples,~~ below.		<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~~\|"Sirius Mods"~~]]</var> Version 7.3.		<li>The <var>UnicodeToEbcdic</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.3.
	</ul>		</ul>

	==Examples==		==Examples==
	~~<ol><li>~~The following example shows multiple calls of <var>UnicodeToEbcdic</var>.		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~~><i~~>Note:~~</i>~~</b> Because of the implicit conversion of <var>Unicode</var> strings (in this case to <var>String</var>), the		<b>Note:</b> Because of the implicit conversion of <var>Unicode</var> strings (in this case to <var>String</var>), the
	<~~p class="~~code">Print %u:UnicodeToEbcdic</p>		<code>Print %u:UnicodeToEbcdic</code>
	statements in the example above could be replaced by		statements in the example above could be replaced by
	<~~p class="~~code">Print %u</p>		<code>Print %u</code>
	statements and the results would be the same.		statements and the results would be the same.
	~~</ol>~~

	==See also==		==See also==
	{{Template:Unicode:UnicodeToEbcdic footer}}		{{Template:Unicode:UnicodeToEbcdic footer}}