$Lstr Unblank: Difference between revisions
mNo edit summary |
(Automatically generated page update) |
||
Line 16: | Line 16: | ||
</p> | </p> | ||
<p>%result is a copy of longstring with leading, trailing, and extra intermediate blank characters removed.</p> | <p><var class="term">%result</var> is a copy of longstring with leading, trailing, and extra intermediate blank characters removed.</p> | ||
==Usage notes== | ==Usage notes== |
Revision as of 18:45, 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!', '!')