UnicodeLeft (Unicode function)

Left-most characters of string to specified length

This function returns the left-most characters of the method object string, possibly padding it on the right.

The UnicodeLeft function is available as of version 7.5 of the Sirius Mods.

Syntax

  %outUni = unicode:unicodeLeft(length, [Pad=char])

Syntax Terms

%outUni

A Unicode variable to receive the result of the UnicodeLeft method.

unicode

A Unicode string.

length

The number of the left-most characters to return. If the method object is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the Pad parameter.

Pad=char

The character used to pad the method object string on the right if it is shorter than the requested length. char defaults to a null, which means no padding is done. Pad is a name-required parameter.

Usage Notes

• The length value must be a non-negative number. A negative number results in request cancellation.
• The pad parameter value must be either null or a single character. A longer value results in a compilation error.
• The UnicodeLeft method is identical to the UnicodeSubstring method (??UnicodeSubstring) with a 1 for the first argument.
• The UnicodeLeft method is analogous to the String intrinsic Left method (??Left).

Examples

The following statement displays Model 2:

   %u is unicode initial('Model 204™':U)
   printText {%u:unicodeLeft(7)}

The following statement displays Model 204!!!:

    %u is unicode initial('Model 204')
    printText {%u:unicodeLeft(12, pad='!')}

The following statement gets a character translation exception because the Unicode character ™ (trademark) has no Ebcdic equivalent:

    %u is unicode initial('Model 204™':U)
    printText {%u:unicodeLeft(10)}