$ParseX

From m204wiki
Revision as of 20:32, 24 October 2012 by JALWiccan (talk | contribs) (1 revision)
Jump to navigation Jump to search

Part of string following character in delimiter set

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $ParseX function, but you might find a more powerful solution in the StringTokenizer class or elements of the Sirius Regex implementation, such as the RegexSplit (String function).

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

The $ParseX 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.

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 = $ParseX(string, delims, start_pos) <section end="syntax" />

$ParseX Function

%PIECE is a piece of the first argument string.

Examples

The following statement would set %JUNK to WANT|NOT:

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

The statement below would set %JUNK to NOT:

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

The following statement would set %JUNK to WASTENOT:

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

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 $Parse would return for this same initial string.

$ParseX returns a null string if none of the delimiter characters are found, unless the second argument is the null string (the default), in which case $ParseX returns the entire first argument string.

Products authorizing $ParseX