$Lstr

From m204wiki
Revision as of 20:29, 10 February 2011 by Alan (talk | contribs)
Jump to navigation Jump to search

<section begin="desc" />Treat a string as longstring<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Lstr function.

This function takes a string or longstring input and produces a longstring output.

The $Lstr function accepts one argument and returns a longstring result.

The first argument is an arbitrary string or longstring.

Syntax

<section begin="syntax" /> %STR = $Lstr(longstring) <section end="syntax" />

$Lstr Function

%STR is a copy of longstring.

The main utility of the $Lstr function is to force a STRING WITH expression that is its argument to be upgraded to a LONGSTRING WITH expression. For example,

IF %COMEDIANS EQ (%WHO WITH ' Costello')

would truncate (%WHO WITH 'Costello') at 255 bytes before the comparison even if %COMEDIANS is a LONGSTRING %variable but

IF %COMEDIANS EQ $Lstr(%WHO WITH ' Costello')

would not.

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

Products authorizing $Lstr