$Lstr Parse: Difference between revisions
m (1 revision) |
mNo edit summary |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Part of longstring preceding character in delimiter set<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Part of longstring preceding character in delimiter set<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_Parse function is [[ | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Parse function is in the [[StringTokenizer class]].</p> | ||
This function returns part of a given string: the characters after a specified or implied starting position and until a character in a delimiter set. | This function returns part of a given string: the characters after a specified or implied starting position and until a character in a delimiter set. | ||
Line 13: | Line 13: | ||
The third argument is a starting position in the first argument string and has a default of 1. | The third argument is a starting position in the first argument string and has a default of 1. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %PIECE = $Lstr_Parse(string, delims, start_pos) | <p class="syntax"><section begin="syntax" /> %PIECE = $Lstr_Parse(string, delims, start_pos) | ||
Line 28: | Line 29: | ||
<p class="code"> %JUNK = $Lstr_Parse('WASTE NOT(WANT|NOT', '|', 5) | <p class="code"> %JUNK = $Lstr_Parse('WASTE NOT(WANT|NOT', '|', 5) | ||
</p> | </p> | ||
$Lstr_Parse returns the entire first argument longstring if none of the delimiter characters are found.<p> | $Lstr_Parse returns the entire first argument longstring if none of the delimiter characters are found.<p> |
Revision as of 22:44, 10 February 2011
<section begin="desc" />Part of longstring preceding character in delimiter set<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Parse function is in the StringTokenizer class.
This function returns part of a given string: the characters after a specified or implied starting position and until a character in a delimiter set.
The $Lstr_Parse function accepts three arguments and returns a string result that is a part of the first input string.
The first argument is an arbitrary string or longstring.
The second argument is a string containing a set of delimiter characters.
The third argument is a starting position in the first argument string and has a default of 1.
Syntax
<section begin="syntax" /> %PIECE = $Lstr_Parse(string, delims, start_pos) <section end="syntax" />
For example, the following statement would set %JUNK to WASTE NOT:
%JUNK = $Lstr_Parse('WASTE NOT(WANT|NOT', '(|')
The statement below would set %JUNK to WASTE NOT(WANT:
%JUNK = $Lstr_Parse('WASTE NOT(WANT|NOT', '|')
The following statement would set %JUNK to E NOT(WANT:
%JUNK = $Lstr_Parse('WASTE NOT(WANT|NOT', '|', 5)
$Lstr_Parse returns the entire first argument longstring if none of the delimiter characters are found.