$Parse: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(28 intermediate revisions by 4 users not shown)
Line 2: Line 2:
<span class="pageSubtitle">Part of string preceding character in delimiter set</span>
<span class="pageSubtitle">Part of string preceding character in delimiter set</span>


<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 [[StringTokenizer class]] or elements of the Sirius Regex implementation, such as the [[RegexSplit (String function)]].</p>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Parse function is the <var>[[Before (String function)|Before]]</var> function. You might also find a more powerful solution in the [[StringTokenizer class]] or elements of the Sirius Regex implementation, such as the <var>[[RegexSplit (String function)|RegexSplit]]</var> <var>String</var> 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 8: Line 8:
The $Parse function accepts three arguments and returns a string result that is a part of the first input string.  
The $Parse 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">$Parse</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.  


Line 13: Line 19:


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==
<p class="syntax"><section begin="syntax" />%PIECE = $Parse(string, delims, start_pos)
<section end="syntax" /></p>
<p class="caption">$Parse Function
</p>
<p class="caption">%PIECE is a piece of the first argument string.</p>


==Examples==
==Examples==
Line 32: Line 31:
</p>
</p>


<var>$Parse</var> 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]].
<var>$Parse</var> 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 <var>[[$ParseX]]</var>.


<h2>Products authorizing {{PAGENAMEE}}</h2><ul class="smallAndTightList">
==Products authorizing {{PAGENAMEE}}==
<li>[[Sirius functions]]</li>
<ul class="smallAndTightList">
<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>[[Japanese functions]]</li>
<li>Japanese functions</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
 
</ul>
</ul>
<p>
</p>


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

Latest revision as of 22:52, 20 September 2018

Part of string preceding character in delimiter set

Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Parse function is the Before function. You might also 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 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.

Syntax

%piece = $Parse(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 in the first argument string and has a default of 1.

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