AsciiToEbcdic (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (first pass, match syntax diagram to template and fix tags; still some broken links)
 
(21 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:String:AsciiToEbcdic subtitle}}
{{Template:String:AsciiToEbcdic subtitle}}
<var>AsciiToEbcdic</var> is an <var>[[Intrinsic classes|intrinsic]]</var> function to convert an ASCII (ISO-8859-1) string to EBCDIC using the current <var>[[Unicode]]</var> tables. Optionally, untranslatable characters are represented with character references.
 
<var>AsciiToEbcdic</var> is an [[Intrinsic classes|intrinsic]] function that converts an ASCII (ISO-8859-1) string to EBCDIC using the current [[Unicode tables]]. Optionally, untranslatable characters are represented with character references.


==Syntax==
==Syntax==
{{Template:String:AsciiToEbcdic syntax}}
{{Template:String:AsciiToEbcdic syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%string</th>
<tr><th>%outString</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 <var class="term">string</var> translated to EBCDIC.</td></tr>
<tr><th><var class="term">string</var></th>
 
<td>A string that is presumed to consist of ASCII characters.</td></tr>
<tr><th>string</th>
<tr><th>CharacterEncode</th>
<td>The input string, which is presumed to consist of ASCII characters.</td></tr>
<td>The optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, argument <var class="term">CharacterEncode</var> argument is a <var>[[Boolean]]</var>; if you specify a value, the parameter name <var class="term">CharacterEncode</var> is required.<ul><li>If its value is <code>False</code>, the default, an exception is thrown if the input <var class="term">string</var> contains any ASCII character not translatable to EBCDIC.<li>If its value is <code>True</code>, any ASCII character not translatable to EBCDIC is replaced with the XML style hexadecimal character reference of the character, and the ampersand character is replaced with <code>'&'</code>.<li>For instance, the six characters <code>'&amp;#x90;'</code> replace the ASCII <i>"Device Control String"</i> character (X'90').  A similar example is shown below.</ul></td></tr>
 
<tr><th><var>CharacterEncode</var></th>
<td>The optional, [[Notation conventions for methods#Named parameters|name required]], <var>CharacterEncode</var> argument is a <var>[[Boolean enumeration]]</var>.  If its value is:
<ul>
<li><var>False</var>, the default, an exception is thrown if the input <var class="term">string</var> contains any ASCII character not translatable to EBCDIC.
 
<li><var>True</var>, any ASCII character not translatable to EBCDIC is replaced with the XML style hexadecimal character reference of the character, and the ampersand character is replaced with <code>'&amp;amp;'</code>.
 
<li>For instance, the six characters <code>&amp;#x90;</code> replace the ASCII "Device Control String" character (X'90').  A similar example is shown below.
</ul>
</td></tr>
</table>
</table>


Line 22: Line 34:


==Usage notes==
==Usage notes==
<ul><li>More information is available about the [[Unicode Tables|Unicode tables]].
<ul><li>More information is available about the [[Unicode tables]].
<li>The <var>AsciiToEbcdic</var> function is available as of <var class="product">Sirius Mods</var> version 7.3.</ul>
<li>The <var>AsciiToEbcdic</var> function is available as of <var class="product">Sirius Mods</var> version 7.3.</ul>


==Examples==
==Examples==
<ol><li>
The following fragment shows calls of <var>AsciiToEbcdic</var> against strings with and without non-translatable characters.
The following fragment shows calls of <var>AsciiToEbcdic</var> against strings with and without non-translatable characters.
<p class="code">%a <var>String</var> Len 20
<p class="code">%a string Len 20
%a = [[Intrinsic X function|'31':X]]
%a = '31':X
Print %a:<var>AsciiToEbcdic</var>
Print %a:AsciiToEbcdic


%a = '318132':X
%a = '318132':[[X (String function)|X]]
Print %a:<var>AsciiToEbcdic</var>(CharacterEncode=True)
Print %a:AsciiToEbcdic(CharacterEncode=True)
Print %a:<var>AsciiToEbcdic</var>
Print %a:AsciiToEbcdic
</p>
</p>
The result is:
The result is:
<p class="output">1
<p class="output">1
1&amp;#x81;2
1&amp;#x81;2
CANCELLING REQUEST: MSIR.0751: Class STRING, function ASCIITOEBCDIC: CHARACTER TRANSLATIONEXCEPTION
CANCELLING REQUEST: MSIR.0751: Class STRING, function ASCIITOEBCDIC: CHARACTERTRANSLATIONEXCEPTION exception: ASCII character X'81' without valid translation to EBCDIC at byte position 1 ...
  exception: ASCII character X'81' without valid translation to EBCDIC at byte position 1 ...
</p>


</p>
</ol>
==See also==
==See also==
<ul><li>The inverse of the <var>AsciiToEbcdic</var> method is <var>[[EbcdicToAscii (String function) | EbcdicToAscii]]</var>.</ul>
<ul><li>The inverse of the <var>AsciiToEbcdic</var> method is <var>[[EbcdicToAscii (String function) | EbcdicToAscii]]</var>.</ul>
{{Template:String:AsciiToEbcdic footer}}
{{Template:String:AsciiToEbcdic footer}}

Latest revision as of 20:46, 15 February 2014

Convert ASCII string to EBCDIC (String class)


AsciiToEbcdic is an intrinsic function that converts an ASCII (ISO-8859-1) string to EBCDIC using the current Unicode tables. Optionally, untranslatable characters are represented with character references.

Syntax

%outString = string:AsciiToEbcdic[( [CharacterEncode= boolean])] Throws CharacterTranslationException

Syntax terms

%outString A string variable to receive the method object string translated to EBCDIC.
string The input string, which is presumed to consist of ASCII characters.
CharacterEncode The optional, name required, CharacterEncode argument is a Boolean enumeration. If its value is:
  • False, the default, an exception is thrown if the input string contains any ASCII character not translatable to EBCDIC.
  • True, any ASCII character not translatable to EBCDIC is replaced with the XML style hexadecimal character reference of the character, and the ampersand character is replaced with '&amp;'.
  • For instance, the six characters &#x90; replace the ASCII "Device Control String" character (X'90'). A similar example is shown below.

Exceptions

AsciiToEbcdic 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

  • More information is available about the Unicode tables.
  • The AsciiToEbcdic function is available as of Sirius Mods version 7.3.

Examples

The following fragment shows calls of AsciiToEbcdic against strings with and without non-translatable characters.

%a string Len 20 %a = '31':X Print %a:AsciiToEbcdic %a = '318132':X Print %a:AsciiToEbcdic(CharacterEncode=True) Print %a:AsciiToEbcdic

The result is:

1 1&#x81;2 CANCELLING REQUEST: MSIR.0751: Class STRING, function ASCIITOEBCDIC: CHARACTERTRANSLATIONEXCEPTION exception: ASCII character X'81' without valid translation to EBCDIC at byte position 1 ...

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=AsciiToEbcdic_(String_function)&oldid=67438"