$Lstr Left: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Leftmost characters of a longstring</span> | <span class="pageSubtitle">Leftmost characters of a longstring</span> | ||
<p class="warn"><b>Note: </b>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> | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Left function is the <var>[[Left (String function)|Left]]</var> 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 17: | Line 17: | ||
<p class="syntax"><span class="term">%result</span> = $Lstr_Left(longstring, len, pad) | <p class="syntax"><span class="term">%result</span> = $Lstr_Left(longstring, len, pad) | ||
</p> | </p> | ||
<p>%result is the leftmost characters of the input longstring, padded with the pad character if necessary.</p> | <p>%result is the leftmost characters of the input longstring, padded with the pad character if necessary.</p> | ||
<var>$Lstr_Left</var> acts very much like $PADR except | ==Usage notes== | ||
<ul> | |||
<li><var>$Lstr_Left</var> 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. | ||
| Line 29: | Line 29: | ||
<li>It can operate on LONGSTRING inputs. | <li>It can operate on LONGSTRING inputs. | ||
<li>It produces a LONGSTRING output. | <li>It produces a LONGSTRING output. | ||
</ul> | |||
</ul> | </ul> | ||
==Examples== | |||
<ol> | |||
<p class="code"> %BIG = $Lstr_Left('Voldemort', 3) | <li>To set %BIG to "Vol": | ||
<p class="code">%BIG = $Lstr_Left('Voldemort', 3) | |||
</p> | </p> | ||
<li>To set %BIG to "Snape" followed by 295 exclamation marks: | |||
<p class="code"> %BIG = $Lstr_Left('Snape', 300, '!') | <p class="code"> %BIG = $Lstr_Left('Snape', 300, '!') | ||
</p> | </p> | ||
</ol> | |||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
| Line 55: | Line 53: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Lstr_Left]] | [[Category:$Functions|$Lstr_Left]] | ||
Revision as of 00:29, 19 July 2013
Leftmost characters of a longstring
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Left function is the Left 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
%result = $Lstr_Left(longstring, len, pad)
%result is the leftmost characters of the input longstring, padded with the pad character if necessary.
Usage notes
- $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.
Examples
- To set %BIG to "Vol":
%BIG = $Lstr_Left('Voldemort', 3)
- To set %BIG to "Snape" followed by 295 exclamation marks:
%BIG = $Lstr_Left('Snape', 300, '!')