$Lstr Unblank: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Remove extraneous blanks from longstring</span> | <span class="pageSubtitle">Remove extraneous blanks from 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_Unblank function is | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Unblank function is <var>[[Unspace (String function)|Unspace]]</var>.</p> | ||
This function takes a string or longstring input and produces the a copy with leading trailing and duplicate internal blanks (or other pad character) removed. | This function takes a string or longstring input and produces the a copy with leading trailing and duplicate internal blanks (or other pad character) removed. | ||
| Line 15: | Line 15: | ||
<p class="syntax"><span class="term">%result</span> = $Lstr_Unblank(longstring, char) | <p class="syntax"><span class="term">%result</span> = $Lstr_Unblank(longstring, char) | ||
</p> | </p> | ||
<p>%result is a copy of longstring with leading, trailing, and extra intermediate blank characters removed.</p> | <p>%result is a copy of longstring with leading, trailing, and extra intermediate blank characters removed.</p> | ||
<var>$Lstr_Unblank</var> acts very much like $UnBlank except | ==Usage notes== | ||
<ul> | |||
<li><var>$Lstr_Unblank</var> acts very much like $UnBlank except: | |||
<ul> | <ul> | ||
| Line 26: | Line 27: | ||
<li>It can operate on a LONGSTRING input. | <li>It can operate on a LONGSTRING input. | ||
<li>It produces a LONGSTRING output. | <li>It produces a LONGSTRING output. | ||
</ul> | |||
</ul> | </ul> | ||
==Examples== | |||
<ol> | |||
<p class="code"> %BIG = $Lstr_Unblank(' Rubeus Hagrid ') | <li>To set %BIG to "Rubeus Hagrid": | ||
<p class="code">%BIG = $Lstr_Unblank(' Rubeus Hagrid ') | |||
</p> | </p> | ||
<li>To set %BIG to "Avada!Kedavra": | |||
<p class="code">%BIG = $Lstr_Unblank('!!Avada!!!!Kedavra!', '!') | |||
<p class="code"> %BIG = $Lstr_Unblank('!!Avada!!!!Kedavra!', '!') | |||
</p> | </p> | ||
</ol> | |||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
| Line 53: | Line 52: | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Lstr_Unblank]] | [[Category:$Functions|$Lstr_Unblank]] | ||
Revision as of 01:17, 19 July 2013
Remove extraneous blanks from longstring
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Unblank function is Unspace.
This function takes a string or longstring input and produces the a copy with leading trailing and duplicate internal blanks (or other pad character) removed.
The $Lstr_Unblank function accepts two 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 string containing a single character that is treated as the blank character. This is an optional argument and defaults to a blank.
Syntax
%result = $Lstr_Unblank(longstring, char)
%result is a copy of longstring with leading, trailing, and extra intermediate blank characters removed.
Usage notes
- $Lstr_Unblank acts very much like $UnBlank except:
- A character other than blank can be specified as the separator character (argument 2).
- It cancels the request if the result target is too short to hold the result.
- It can operate on a LONGSTRING input.
- It produces a LONGSTRING output.
Examples
- To set %BIG to "Rubeus Hagrid":
%BIG = $Lstr_Unblank(' Rubeus Hagrid ')
- To set %BIG to "Avada!Kedavra":
%BIG = $Lstr_Unblank('!!Avada!!!!Kedavra!', '!')