$ParseX: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
|||
| (44 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$ParseX}} | {{DISPLAYTITLE:$ParseX}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Part of string following character in delimiter set</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ParseX function is the <var>[[After (String function)|After]]</var> function. You might also find a more powerful solution in the [[StringTokenizer class]] or elements of the Sirius Regex implementation, such as <var>[[RegexSplit (String function)|RegexSplit]]</var>.</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. | ||
The $ParseX function accepts three arguments and returns a string result that is a part of the first input string. | The <var>$ParseX</var> function accepts three arguments and returns a string result that is a part of the first input string. | ||
==Syntax== | |||
<p class="syntax"><span class="term">%piece</span> = <span class="literal">$ParseX</span>(<span class="term">string</span>, <span class="term">delims</span>, [<span class="term">start_pos</span>]) | |||
</p> | |||
<p> | |||
<var class="term">%piece</var> is a piece of the first argument string.</p> | |||
The first argument is an arbitrary string. | The first argument is an arbitrary string. | ||
The second argument is a string containing a set of delimiter characters. | 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. | The third argument is a starting position after a prefix in the first argument string and has a default of 1. | ||
< | If the second argument is the null string, <var>$ParseX</var> returns the entire first argument string. | ||
< | |||
< | If the second argument is <b>not</b> the null string, and none of the delimiter characters are found, <var>$ParseX</var> returns the prefix (the characters before <var class="term">start_pos</var>). | ||
</ | |||
< | ==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 25: | Line 31: | ||
<p class="code"> %JUNK = $ParseX('WASTE NOT(WANT|NOT', '|') | <p class="code"> %JUNK = $ParseX('WASTE NOT(WANT|NOT', '|') | ||
</p> | </p> | ||
The following statement would set % | The following statement would set <code>%junk</code> to <code>WASTENOT</code>: | ||
<p class="code"> % | <p class="code">%junk = $ParseX('WASTE NOT(WANT|NOT', '|', 6) | ||
</p> | </p> | ||
Notes: | |||
<ul> | |||
<li>This last result string is a concatenation of the prefix (the characters that precede the starting position character in the initial string) and the characters that follow the delimiter character. | |||
<li>The characters that are '''not''' in this result string are exactly the characters that <var>[[$ParseX]]</var> would return for this same initial string. | |||
<li>The <var>[[$Lstr_ParseX]]</var> function differs somewhat from <var>$ParseX</var>. Specifically, <var>$Lstr_ParseX</var> does not use the "prefix" notion; it simply skips the characters prior to the <var class="term">start_pos</var>. | |||
</ul> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$ParseX]] | [[Category:$Functions|$ParseX]] | ||
Latest revision as of 03:02, 19 March 2019
Part of string following character in delimiter set
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ParseX function is the After function. You might also find a more powerful solution in the StringTokenizer class or elements of the Sirius Regex implementation, such as RegexSplit.
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.
Syntax
%piece = $ParseX(string, delims, [start_pos])
%piece is a piece of the first argument 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 after a prefix in the first argument string and has a default of 1.
If the second argument is the null string, $ParseX returns the entire first argument string.
If the second argument is not the null string, and none of the delimiter characters are found, $ParseX returns the prefix (the characters before start_pos).
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)
Notes:
- This last result string is a concatenation of the prefix (the characters that precede the starting position character in the initial string) and the characters that follow the delimiter character.
- The characters that are not in this result string are exactly the characters that $ParseX would return for this same initial string.
- The $Lstr_ParseX function differs somewhat from $ParseX. Specifically, $Lstr_ParseX does not use the "prefix" notion; it simply skips the characters prior to the start_pos.