AsciiToEbcdic (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(47 intermediate revisions by 8 users not shown)
Line 1: Line 1:
This [[Intrinsic classes|intrinsic]] function converts an ASCII (ISO-8859-1) string to EBCDIC
{{Template:String:AsciiToEbcdic subtitle}}
using the current Unicode tables.                                                           
Optionally,                                                                                 
untranslatable characters are represented with character references.                       
                                                                                           
The AsciiToEbcdic function is available as of version 7.3 of the [[Sirius Mods]].           
===AsciiToEbcdic syntax===                                                                 
  %ebcdic = string:AsciiToEbcdic([CharacterEncode=bool])                                   
====Syntax Terms====                                                                       
<dl>                                                                                       
<dt>%ebcdic                                                                                 
<dd>A string variable to receive the method object string translated to EBCDIC.             
<dt>string                                                                                 
<dd>A string that is presumed to consist of ASCII characters.                               
<dt>CharacterEncode=bool                                                           
<dd>The optional (name required) CharacterEncode argument is a Boolean:                     
*If its value is ''''False'''', the default, an exception is thrown if the input contains any ASCII character not translatable to EBCDIC.             
*If its value is ''''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.amp;''''.                 
                                                                               
For instance, the six characters '&amp;#x90;' replace the ASCII                     
''Device Control String'' character (X'90').                               
A similar example is shown below.             
                                                                               
</dl>                                                                           
===Exceptions===                                                                     
                                                                               
This [[Intrinsic classes|intrinsic]] function can throw the following exception:  
<dl>                                                                           
<dt>[[CharacterTranslationException]]                                               
<dd>If the method encounters a translation problem,                             
properties of the exception object may indicate the location and type of problem.                                                 
</dl>                                                                           
===Usage Notes===                                                               
*More information is available about the [[Unicode Tables|Unicode tables]].         
*The inverse of the AsciiToEbcdic method is [[EbcdicToAscii (String function) | EbcdicToAscii]].


===Examples===                                                                 
<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.
                                                                               
The following fragment shows calls of AsciiToEbcdic against strings with and   
without non-translatable characters.                                                                                 
    %a String Len 20                                                 
    %a = [[Intrinsix X function|'31':X]]                                                      
    Print %a:AsciiToEbcdic                                           
                                                                     
    %a = '318132':X                                                 
    Print %a:AsciiToEbcdic(CharacterEncode=True)                    
    Print %a:AsciiToEbcdic                                           
The result is:                                                       
    1                                                               
    1&amp;#x81;2                                                         
    CANCELLING REQUEST: MSIR.0751: Class STRING, function ASCIITOEBCDIC: CHARACTER TRANSLATIONEXCEPTION                 
      exception: ASCII character X'81' without valid translation to EBCDIC at byte position 1 ...


===See also===                                                                                       
==Syntax==
[[List of intrinsic String methods]]
{{Template:String:AsciiToEbcdic syntax}}


[[Category:Intrinsic String methods|AsciiToEbcdic function]]
===Syntax terms===
[[Category:Intrinsic methods]]
<table class="syntaxTable">
[[Category:System methods]]
<tr><th>%outString</th>
<td>A string variable to receive the method object <var class="term">string</var> translated to EBCDIC.</td></tr>
 
<tr><th>string</th>
<td>The input string, which is presumed to consist of ASCII characters.</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>
 
==Exceptions==
<var>AsciiToEbcdic</var> can throw the following exception:
<dl>
<dt><var>[[CharacterTranslationException class|CharacterTranslationException]]</var>
<dd>If the method encounters a translation problem, properties of the exception object may indicate the location and type of problem.
</dl>
 
==Usage notes==
<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>
 
==Examples==
The following fragment shows calls of <var>AsciiToEbcdic</var> against strings with and without non-translatable characters.
<p class="code">%a string Len 20
%a = '31':X
Print %a:AsciiToEbcdic
 
%a = '318132':[[X (String function)|X]]
Print %a:AsciiToEbcdic(CharacterEncode=True)
Print %a:AsciiToEbcdic
</p>
The result is:
<p class="output">1
1&amp;#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 ...
</p>
 
==See also==
<ul><li>The inverse of the <var>AsciiToEbcdic</var> method is <var>[[EbcdicToAscii (String function) | EbcdicToAscii]]</var>.</ul>
{{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"