AsciiToEbcdic (String function)

From m204wiki
Revision as of 05:05, 31 January 2011 by Goff (talk | contribs) (found the X sting function)
Jump to navigation Jump to search

Convert ASCII string to EBCDIC (String class)


AsciiToEbcdic is an intrinsic function to convert 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

%string A string variable to receive the method object string translated to EBCDIC.
string A string that is presumed to consist of ASCII characters.
CharacterEncode The optional, but NameRequired, argument CharacterEncode argument is a Boolean enumeration; if you specify a value, the parameter name CharacterEncode is required.
  • If its value is False, the default, an exception is thrown if the input string 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 '&'.
  • For instance, the six characters '' 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

  1. The following fragment shows calls of AsciiToEbcdic against strings with and without non-translatable characters. The X constant function is used in the example.

    %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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