StringUpTo (StringTokenizer function): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:StringTokenizer:StringUpTo subtitle}} | {{Template:StringTokenizer:StringUpTo subtitle}} | ||
This | This method returns a substring of the tokenizing string, starting at the current position and ending just before the occurrence of its argument string. And it advances the tokenizer position past the next occurrence of its argument string. | ||
==Syntax== | ==Syntax== | ||
{{Template:StringTokenizer:StringUpTo syntax}} | {{Template:StringTokenizer:StringUpTo syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string</th><td>string</td></tr> | <tr><th>%string</th> | ||
<td>A string variable to contain the returned substring.</td></tr> | |||
<tr><th>stringTokenizer</th> | <tr><th>stringTokenizer</th> | ||
<td>StringTokenizer object</td></tr> | <td>A <var>StringTokenizer</var> object expression.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>string</td></tr> | <td>The string within <var class="term">stringTokenizer</var> up to which the tokenizer scans to determine the substring to return to <var class="term">%string</var>. | ||
<p>If <var class="term">string</var> is not found, <var>StringUpTo</var> returns ???. | |||
</p></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:StringTokenizer:StringUpTo footer}} | {{Template:StringTokenizer:StringUpTo footer}} | ||
Revision as of 01:21, 29 June 2012
String from start to current position (StringTokenizer class)
[Introduced in Sirius Mods 7.8]
This method returns a substring of the tokenizing string, starting at the current position and ending just before the occurrence of its argument string. And it advances the tokenizer position past the next occurrence of its argument string.
Syntax
%string = stringTokenizer:StringUpTo( string)
Syntax terms
| %string | A string variable to contain the returned substring. |
|---|---|
| stringTokenizer | A StringTokenizer object expression. |
| string | The string within stringTokenizer up to which the tokenizer scans to determine the substring to return to %string.
If string is not found, StringUpTo returns ???. |