UnicodeToEbcdic (Unicode function)

Translate to Ebcdic (Unicode class)

This function converts a Unicode string to EBCDIC. As an option, untranslatable characters can be represented with XML style hexadecimal character references.

The UnicodeToEbcdic function is available as of version 7.3 of the Sirius Mods.

Syntax

%string = unicode:UnicodeToEbcdic[( [CharacterEncode= boolean])] Throws CharacterTranslationException

Syntax terms

%ebcdic	A string variable to receive the method object string translated to EBCDIC.
unicode	A `Unicode` string.
CharacterEncode=bool	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 `Unicode` character not translatable to EBCDIC. If its value is `True`, any `Unicode` character not translatable to EBCDIC is replaced with the hexadecimal character reference of the character, and the ampersand character is replaced with `&`. For example, the eight characters `“` replace the `Unicode` "left double-quotation mark."

Exceptions

This function 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. See CharacterTranslationException exception class.

Usage notes

Unless the CharacterEncode argument is used, or you want to Catch a CharacterTranslationException, this function is generally not needed, because a Unicode string is implicitly converted to EBCDIC when used in an EBCDIC context. See the example in "Examples," below.
The EbcdicToUnicode method converts an EBCDIC string to Unicode.

Examples

The following example shows multiple calls of UnicodeToEbcdic. The U constant function is used in the example.

    %u <var>Unicode</var> Initial('&#x31;':U)
    Print %u:<var>UnicodeToEbcdic</var>

    %u = '1&#x80;2':U
    Print %u:<var>UnicodeToEbcdic</var>(CharacterEncode=True)
    Print %u:<var>UnicodeToEbcdic</var>

The result of the above fragment is:

    1
    1&#x0080;2
    CANCELLING REQUEST: MSIR.0751: Class STRING, function
      UNICODETOEBCDIC: CHARACTER TRANSLATIONEXCEPTION
      exception: <var>Unicode</var> character U+0080 without valid
      translation to EBCDIC at byte position 5 ...

Note: Because of the implicit conversion of Unicode strings (in this case to String),
the Print %u:UnicodeToEbcdic statements in the example above could be
replaced by Print %u statements and the results would be the same.