$Lstr_ParseX

From m204wiki
Jump to navigation Jump to search

Part of longstring following character in delimiter set

Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_ParseX function is the After function; also see the StringTokenizer class.

This function returns the part(s) of a longstring that remain after removing the part of the string that is delimited by a character in a delimiter set.

The $Lstr_ParseX function accepts three arguments and returns a longstring result that is a part of the first input long 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_ParseX(string, delims, [start_pos])

%PIECE is a piece of the first argument string.

For example, the following statement would set %JUNK to WANT|NOT:

%JUNK = $Lstr_ParseX('WASTE NOT(WANT|NOT', '(|')

The statement below would set %JUNK to NOT:

%JUNK = $Lstr_ParseX('WASTE NOT(WANT|NOT', '|')

The following statement would set %JUNK to WASTENOT:

%JUNK = $Lstr_ParseX('WASTE NOT(WANT|NOT', '|', 6)

Note:

  • The $ParseX function differs somewhat from $Lstr_ParseX. Specifically, $ParseX returns the prefix of the first argument (the characters prior to start_pos) concatenated with the characters following the delimiter character.

Note that this last result string is a concatenation of the characters that precede the starting position character in the initial string and the characters that follow the delimiter character. Also note that the characters that are not in this result string are exactly the characters that $Lstr_Parse would return for this same initial string.

$Lstr_ParseX returns a null string if none of the delimiter characters are found.

Products authorizing $Lstr_ParseX