$ParseX: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />Part of string following character in delimiter set<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Part of string following 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 $ParseX function is [[to be entered]].</p>
<p class="warning">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)]].</p>


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.  
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.  
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 = $ParseX(string, delims, start_pos)
<p class="syntax"><section begin="syntax" /> %PIECE = $ParseX(string, delims, start_pos)
Line 19: Line 20:
</p>
</p>
<p class="caption">%PIECE is a piece of the first argument string.</p>
<p class="caption">%PIECE is a piece of the first argument string.</p>
For example, the following statement would set %JUNK to <tt>WANT|NOT</tt>:
 
==Examples==
The following statement would set %JUNK to <tt>WANT|NOT</tt>:
<p class="code"> %JUNK = $ParseX('WASTE NOT(WANT|NOT', '(|')
<p class="code"> %JUNK = $ParseX('WASTE NOT(WANT|NOT', '(|')
</p>
</p>
Line 29: Line 32:
</p>
</p>


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.


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.


$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.
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[Sirius functions]]</li>
Line 42: Line 45:
<li>[[Japanese functions]]</li>
<li>[[Japanese functions]]</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Sir2000 Field Migration Facility]]</li>
</ul>
</ul>
<p class="caption">Products authorizing $ParseX
<p class="caption">Products authorizing $ParseX
</p>
</p>


[[Category:$Functions|$ParseX]]
[[Category:$Functions|$ParseX]]

Revision as of 21:29, 1 February 2011

<section begin="desc" />Part of string following character in delimiter set<section end="desc" />

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

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$ParseX&oldid=29606"