$Lstr Left: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />Leftmost characters of a longstring<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Leftmost characters of a longstring<section end="desc" /></span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Left function is [[to be entered]].</p>
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Left function is the [[Left (String function)]].</p>


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


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.
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.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RESULT = $Lstr_Left(longstring, len, pad)
<p class="syntax"><section begin="syntax" /> %RESULT = $Lstr_Left(longstring, len, pad)
Line 21: Line 22:


$Lstr_Left acts very much like $PADR except
$Lstr_Left acts very much like $PADR except
<ul>
<ul>
<li>The target length and pad character arguments are reversed.  
<li>The target length and pad character arguments are reversed.  
<li>It cancels the request if the result target is too short to hold the result.  
<li>It cancels the request if the result target is too short to hold the result.  
Line 31: Line 32:


For example
For example
<p class="code"> %BIG = $Lstr_Left('Voldemort', 3)
<p class="code"> %BIG = $Lstr_Left('Voldemort', 3)
</p>
</p>
sets %BIG to "Vol&CQ. and
 
sets %BIG to "Vol". and
 
<p class="code"> %BIG = $Lstr_Left('Snape', 300, '!')
<p class="code"> %BIG = $Lstr_Left('Snape', 300, '!')
</p>
</p>
sets %BIG to "Snape&CQ. followed by 295 exclamation marks.


For more information see :hdref refid=lstr..  
sets %BIG to "Snape" followed by 295 exclamation marks.  


$Lstr_Left is only available in ''[[Sirius Mods]]'' Version 6.2 and later.<p>
$Lstr_Left is only available in ''[[Sirius Mods]]'' Version 6.2 and later.<p>

Revision as of 21:42, 10 February 2011

<section begin="desc" />Leftmost characters of a longstring<section end="desc" />

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

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

The $Lstr_Left 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.

Syntax

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

$Lstr_Left function

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

$Lstr_Left acts very much like $PADR 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_Left('Voldemort', 3)

sets %BIG to "Vol". and

%BIG = $Lstr_Left('Snape', 300, '!')

sets %BIG to "Snape" followed by 295 exclamation marks.

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

Products authorizing $Lstr_Left