$Lstr Parse: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
(Automatically generated page update)
 
Line 2: Line 2:
<span class="pageSubtitle">Part of longstring preceding character in delimiter set</span>
<span class="pageSubtitle">Part of longstring preceding character in delimiter set</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_Parse function is the <var>[[Before (String function)|Before]]</var> function; also see the <var>[[StringTokenizer class|StringTokenizer]]</var> class.</p>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Parse function is the <var>[[Before (String function)|Before]]</var> function; also see the <var>[[StringTokenizer class|StringTokenizer]]</var> 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.  

Latest revision as of 22:52, 20 September 2018

Part of longstring preceding character in delimiter set

Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Parse function is the Before function; also see 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

%PIECE = $Lstr_Parse(string, delims, [start_pos])

%PIECE is a piece of the first argument string.

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.

Products authorizing $Lstr_Parse