UnicodeRight (Unicode function)
The right-most characters of the string (Unicode class)
UnicodeRight returns a specified number of the right-most characters of the method object string, possibly padding them on the left.
Syntax
%outUnicode = unicode:UnicodeRight( number, [Pad= c])
Syntax terms
| %outUnicode | A Unicode variable to receive the result of the UnicodeRight method. |
|---|---|
| unicode | A Unicode string. |
| number | The number of the right-most characters to return. If the method object, unicode, 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 | Specifies the character used to pad the method object string on the left if it is shorter than the requested length. Pad defaults to the null string (''), which means no padding is done. Pad is a Name-Required parameter. |
Usage notes
- The output length specified in number 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.
- UnicodeRight can be useful for right-justifying a value in a string, most typically by using a blank as pad character.
- UnicodeRight is analogous to the String intrinsic Right method.
- UnicodeRight function is available as of "Sirius Mods" Version 7.5.
Examples
-
The following statement places the right-most 5 characters of %x into %y. If %x is shorter than 6 characters, then all of %x is copied into %y:
%y = %x:unicodeRight(5)
- The following request right-aligns a text string and a number, padding each on the left with a different character. This example also shows that the argument for the method's Pad parameter may be a Unicode string (which gets converted implicitly to String).
begin %u2 unicode initial('inaugural') %pad is string len 4 %len is float printText {%u2:unicodeRight(10, pad=' ')} printText {123:unicodeRight(10, pad='@':U)} end
The result is:
inaugural @@@@@@@123