$Parse: 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 preceding character in delimiter set<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Part of string 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 $Parse 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 $Parse function, but you might find a more powerful solution in the [[String tokenizer]] or elements of the Sirius Regex implementation, such as the [[RegexSplit (String function)]].</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 = $Parse(string, delims, start_pos)
<p class="syntax"><section begin="syntax" /> %PIECE = $Parse(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>WASTE NOT</tt>:
 
==Examples==
The following statement would set %JUNK to <tt>WASTE NOT</tt>:
<p class="code"> %JUNK = $Parse('WASTE NOT(WANT|NOT', '(|')
<p class="code"> %JUNK = $Parse('WASTE NOT(WANT|NOT', '(|')
</p>
</p>
Line 29: Line 32:
</p>
</p>


$Parse returns the entire first argument string if none of the delimiter characters are found.  The matching function which retrieves the part of the string after the delimiter is [[$ParseX]].


$Parse returns the entire first argument string if none of the delimiter characters are found.
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[Sirius functions]]</li>
Line 44: Line 47:
<p class="caption">Products authorizing $Parse
<p class="caption">Products authorizing $Parse
</p>
</p>


[[Category:$Functions|$Parse]]
[[Category:$Functions|$Parse]]

Revision as of 21:26, 1 February 2011

<section begin="desc" />Part of string preceding 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 $Parse function, but you might find a more powerful solution in the String tokenizer or elements of the Sirius Regex implementation, such as the RegexSplit (String function).

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

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

$Parse Function

%PIECE is a piece of the first argument string.

Examples

The following statement would set %JUNK to WASTE NOT:

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

The statement below would set %JUNK to WASTE NOT(WANT:

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

The following statement would set %JUNK to E NOT(WANT:

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

$Parse returns the entire first argument string if none of the delimiter characters are found. The matching function which retrieves the part of the string after the delimiter is $ParseX.

Products authorizing $Parse