$Lstr Unblank: Difference between revisions
m (1 revision) |
m (1 revision) |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle">Remove extraneous blanks from longstring</span> | <span class="pageSubtitle">Remove extraneous blanks from longstring</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Unblank function is the [[Unspace (String function)]].</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$Lstr_Unblank</var> function is the [[Unspace (String function)]].</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. | ||
The $Lstr_Unblank function accepts two arguments and returns a string result. | The <var>$Lstr_Unblank</var> function accepts two arguments and returns a string result. | ||
The first argument is an arbitrary string or longstring. This is a required argument. | The first argument is an arbitrary string or longstring. This is a required argument. |
Revision as of 18:03, 19 October 2012
Remove extraneous blanks from longstring
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Unblank function is the Unspace (String function).
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
<section begin="syntax" /> %RESULT = $Lstr_Unblank(longstring, char) <section end="syntax" />
$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.
For example
%BIG = $Lstr_Unblank(' Rubeus Hagrid ')
sets %BIG to "Rubeus Hagrid" and
%BIG = $Lstr_Unblank('!!Avada!!!!Kedavra!', '!')
sets %BIG to "Avada!Kedavra".