Right (String function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 12: | Line 12: | ||
<td>The input, method object, string to which the method is applied.</td></tr> | <td>The input, method object, string to which the method is applied.</td></tr> | ||
<tr><th>length</th> | <tr><th>length</th> | ||
<td>The number of the right-most bytes to return. If the method object <var class="term">string</var> is shorter than the requested <var class="term">length</var>, it is either padded to the requested length or the entire method object <var class="term">string</var> is returned with no padding, depending on the value of the <var | <td>The number of the right-most bytes to return. If the method object <var class="term">string</var> is shorter than the requested <var class="term">length</var>, it is either padded to the requested length or the entire method object <var class="term">string</var> is returned with no padding, depending on the value of the <var>Pad</var> parameter.</td></tr> | ||
<tr><th><var>Pad</var></th> | <tr><th><var>Pad</var></th> | ||
<td> | <td>An optional, [[Notation conventions for methods#Named parameters|name required]], parameter used to pad the method object, <var class="term">string</var>, on the left, if it is shorter than the requested <var class="term">length</var>. <var>Pad</var> defaults to a single blank space. If set to the null string, no padding is performed.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>The length must be a non-negative number. A negative number results in request cancellation. | <ul> | ||
<li>The | <li>The <var class="term">length</var> value must be a non-negative number. A negative number results in request cancellation. | ||
<li>The <var>Pad</var> argument must be either the null string or a single character. A longer value results in request cancellation in <var class="product">Sirius Mods</var> Version 7.2 and in a compilation error in <var class="product">Sirius Mods</var> Version 7.3 and higher. | |||
<li><var>Right</var> can be useful for right-justifying a value in a string, most typically by using a blank space as pad character. | <li><var>Right</var> can be useful for right-justifying a value in a string, most typically by using a blank space as pad character. | ||
<li><var>Right</var> is available as of <var class="product"> | <li><var>Right</var> is available as of <var class="product">Sirius Mods</var> version 7.2. | ||
</ul> | |||
==Examples== | ==Examples== | ||
The following places the right-most 5 bytes of <code>%x</code> into <code>%y</code>. If <code>%x</code> contains fewer than 6 bytes, then all of <code>%x</code> is copied into <code>%y</code>, padded on the left with blanks: | |||
<p class="code">%y = %x:right(5) | <p class="code">%y = %x:right(5) | ||
</p> | </p> | ||
| Line 32: | Line 34: | ||
printText {123:right(5)} | printText {123:right(5)} | ||
printText {99:right(5)} | printText {99:right(5)} | ||
printText {88:right(5, pad= | printText {88:right(5, pad='')} | ||
end | end | ||
</p | </p> | ||
==See also== | ==See also== | ||
{{Template:String:Right footer}} | {{Template:String:Right footer}} | ||
Latest revision as of 22:00, 7 August 2012
The right-most characters of the string (String class)
The Right intrinsic function returns the right-most characters of the method object string, possibly padding it on the left.
Syntax
%outString = string:Right( length, [Pad= c])
Syntax terms
| %outString | A variable to receive the string result of the Right method. |
|---|---|
| string | The input, method object, string to which the method is applied. |
| length | The number of the right-most bytes to return. If the method object string is shorter than the requested length, 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 | An optional, name required, parameter used to pad the method object, string, on the left, if it is shorter than the requested length. Pad defaults to a single blank space. If set to the null string, no padding is performed. |
Usage notes
- The length value must be a non-negative number. A negative number results in request cancellation.
- The Pad argument must be either the null string or a single character. A longer value results in request cancellation in Sirius Mods Version 7.2 and in a compilation error in Sirius Mods Version 7.3 and higher.
- Right can be useful for right-justifying a value in a string, most typically by using a blank space as pad character.
- Right is available as of Sirius Mods version 7.2.
Examples
The following places the right-most 5 bytes of %x into %y. If %x contains fewer than 6 bytes, then all of %x is copied into %y, padded on the left with blanks:
%y = %x:right(5)
The following request right-justifies the numbers 7, 123, and 99, and it left-justifies the number 88:
begin printText {7:right(5)} printText {123:right(5)} printText {99:right(5)} printText {88:right(5, pad='')} end