$Lstr: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 2: Line 2:
<span class="pageSubtitle">Treat a string as longstring</span>
<span class="pageSubtitle">Treat a string as longstring</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Lstr function.</p>
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$Lstr</var> function.</p>


This function takes a string or longstring input and produces a longstring output.  
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 <var>$Lstr</var> function accepts one argument and returns a longstring result.  


The first argument is an arbitrary string or longstring.
The first argument is an arbitrary string or longstring.
Line 17: Line 17:
<p class="caption">%STR is a copy of longstring.</p>
<p class="caption">%STR is a copy of longstring.</p>


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.
The main utility of the <var>$Lstr</var> function is to force a STRING WITH expression that is its argument to be upgraded to a LONGSTRING WITH expression.
For example,
For example,



Revision as of 18:03, 19 October 2012

Treat a string as longstring

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