UnicodeRight (Unicode function): Difference between revisions
Jump to navigation
Jump to search
m (syntax terms and tags) |
mNo edit summary |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Unicode:UnicodeRight subtitle}} | {{Template:Unicode:UnicodeRight subtitle}} | ||
<var>UnicodeRight</var> returns the specified number of the right-most characters of the method object string, possibly padding them on the left. | |||
<var>UnicodeRight</var> returns | |||
==Syntax== | ==Syntax== | ||
{{Template:Unicode:UnicodeRight syntax}} | {{Template:Unicode:UnicodeRight syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%outUnicode</th> | <tr><th>%outUnicode</th> | ||
<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeRight</var> method. </td></tr> | <td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeRight</var> method. </td></tr> | ||
<tr><th>unicode</th> | <tr><th>unicode</th> | ||
<td>A <var>Unicode</var> string. </td></tr> | <td>A <var>Unicode</var> string. </td></tr> | ||
<tr><th>number</th> | <tr><th>number</th> | ||
<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, 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 <var | <td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, 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 <var>Pad</var> parameter. </td></tr> | ||
<tr><th> | |||
<td>Specifies the character used to pad the method object string on the left if it is shorter than the requested length. <var | <tr><th><var>Pad</var></th> | ||
<td>Specifies the character used to pad the method object string, on the left, if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<tt><nowiki>''</nowiki></tt>), which means no padding is done. <var>Pad</var> is a [[Notation conventions for methods#Named parameters|name required]] parameter.</td></tr> | |||
</table> | </table> | ||
| Line 20: | Line 23: | ||
<ul> | <ul> | ||
<li>The output length specified in <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation. | <li>The output length specified in <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation. | ||
<li>The <var | <li>The <var>Pad</var> parameter value must be either null or a single character. A longer value results in a compilation error. | ||
<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character. | <li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character. | ||
<li><var>UnicodeRight</var> function is available as of <var class="product">Sirius Mods</var> Version 7.5. | |||
<li><var>UnicodeRight</var> function is available as of <var class="product"> | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
<ol><li> | <ol> | ||
The following statement places the right-most 5 characters of %x into %y. | <li>The following statement places the right-most 5 characters of <code>%x</code> into <code>%y</code>. If <code>%x</code> is shorter than 6 characters, all of <code>%x</code> is copied into <code>%y</code>: | ||
<p class="code">%y = %x:unicodeRight(5) | <p class="code">%y = %x:unicodeRight(5) | ||
</p> | </p> | ||
<li>The following request right-aligns a text string and a number, padding each on the left with a different character. | <li>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 <var>Pad</var> parameter may be a <var>Unicode</var> string (which gets converted implicitly to <var>String</var>). | ||
<p class="code">begin | <p class="code">begin | ||
%u2 unicode initial('inaugural') | %u2 unicode initial('inaugural') | ||
| Line 41: | Line 43: | ||
end | end | ||
</p> | </p> | ||
The result is: | The result is: | ||
<p class="output">inaugural | <p class="output">inaugural | ||
| Line 48: | Line 49: | ||
==See also== | ==See also== | ||
<ul> | |||
<li><var>UnicodeRight</var> is analogous to the <var>String</var> intrinsic <var>[[Right (String function)|Right]]</var> method. | |||
</ul> | |||
{{Template:Unicode:UnicodeRight footer}} | {{Template:Unicode:UnicodeRight footer}} | ||
Latest revision as of 17:40, 6 November 2012
The right-most characters of the string (Unicode class)
UnicodeRight returns the 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 function is available as of Sirius Mods Version 7.5.
Examples
- The following statement places the right-most 5 characters of
%xinto%y. If%xis shorter than 6 characters, all of%xis 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
See also
- UnicodeRight is analogous to the String intrinsic Right method.