From m204wiki
Revision as of 21:21, 22 November 2011 by DmeWiccan (talk | contribs) (1 revision)
Jump to navigation Jump to search

Rightmost characters of a longstring

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Right function is the Right (String function).

This function takes a string or longstring input and produces the rightmost characters of the input, possibly padded to an indicated length.

The $Lstr_Right function accepts three arguments and returns a string result.

The first argument is an arbitrary string or longstring. This is a required argument.

The second argument is a number between 1 and 2**31-1 that indicates the result length. This is a required argument.

The third argument is a string containing a single character to be used as the pad character if the result length is longer than the string specified by argument one. This is an optional argument and defaults to a blank.


<section begin="syntax" /> %RESULT = $Lstr_Right(longstring, len, pad) <section end="syntax" />

$Lstr_Right function

%RESULT is the rightmost characters of the input longstring, padded with the pad character if necessary.

$Lstr_Right acts very much like $PAD except

  • The target length and pad character arguments are reversed.
  • It cancels the request if the result target is too short to hold the result.
  • It cancels the request if the pad character argument is longer than one byte.
  • It can operate on LONGSTRING inputs.
  • It produces a LONGSTRING output.

For example

%BIG = $Lstr_Right('McGonagall', 3)

sets %BIG to "all&CQ. and

%BIG = $Lstr_Right('Dumbledore', 300, '?')

sets %BIG to 290 question marks followed by "Dumbledore&CQ..

$Lstr_Right is only available in Sirius Mods Version 6.2 and later.

Products authorizing $Lstr_Right