IsOneOf (String function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:String:IsOneOf subtitle}} | {{Template:String:IsOneOf subtitle}} | ||
This [[Intrinsic classes|intrinsic]] function returns a Boolean value that indicates whether the method object | This [[Intrinsic classes|intrinsic]] function returns a <var>Boolean</var> value that indicates whether the method object | ||
string is matched by one of the strings in an input list of strings. | string is matched by one of the strings in an input list of strings. | ||
The input list of strings is concatenated in a single delimited longstring argument to the method. | The input list of strings is concatenated in a single delimited longstring argument to the method. | ||
A returned value of | A returned value of <var>True</var> signals a successful match. | ||
The <var>IsOneOf</var> function is available as of version 7.3 of the <var class=product>Sirius Mods</var>. | The <var>IsOneOf</var> function is available as of version 7.3 of the <var class=product>Sirius Mods</var>. | ||
| Line 11: | Line 11: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%boolean</th> | ||
<td>An enumeration object of type Boolean to contain the returned value of <var>IsOneOf</var>. </td></tr> | <td>An enumeration object of type <var>Boolean</var> to contain the returned value of <var>IsOneOf</var>. </td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>The string to which the method is applied, the maximum length of which is 255 bytes. </td></tr> | <td>The string to which the method is applied, the maximum length of which is 255 bytes. </td></tr> | ||
<tr><th> | <tr><th>list</th> | ||
<td>A longstring that contains a delimited set of potential matching strings | <td>A longstring that contains a delimited set of potential matching strings for the method object string. The strings in <var class="term">list</var> are separated by a separator character, which must be indicated by the first character of the argument. The separator must be non-alphanumeric. The format of <var class="term">list</var> is therefore | ||
<p class="syntax">separatorString1[separatorString2]...</p></td></tr> | |||
</table> | </table> | ||
| Line 24: | Line 25: | ||
The following are <var>IsOneOf</var> sample statements: | The following are <var>IsOneOf</var> sample statements: | ||
<p class="code">%str is longstring | |||
%str = 'bleh' | |||
[[Intrinsic classes#printtext|printText]] {~} = '{%str:isOneOf('/blah/bleh/blih')}' | |||
printText {~} = '{%str:isOneOf(',blah,bleh,blih')}' | |||
printText {~} = '{%str:isOneOf('/blah/blh/blih')}' | |||
</p> | |||
The results are respectively: | The results are respectively: | ||
<p class="output">%str:isOneOf('/blah/bleh/blih') = True | |||
%str:isOneOf(',blah,bleh,blih') = True | |||
%str:isOneOf('/blah/blh/blih') = False | |||
</p>[[Category:String methods|IsOneOf function]] | |||
[[Category:String methods|IsOneOf function]] | |||
[[Category:Intrinsic methods]] | [[Category:Intrinsic methods]] | ||
Revision as of 17:02, 19 January 2011
Is the method object string matched by any of the strings in the input list? (String class)
This intrinsic function returns a Boolean value that indicates whether the method object
string is matched by one of the strings in an input list of strings.
The input list of strings is concatenated in a single delimited longstring argument to the method.
A returned value of True signals a successful match.
The IsOneOf function is available as of version 7.3 of the Sirius Mods.
Syntax
%boolean = string:IsOneOf( list)
Syntax terms
| %boolean | An enumeration object of type Boolean to contain the returned value of IsOneOf. |
|---|---|
| string | The string to which the method is applied, the maximum length of which is 255 bytes. |
| list | A longstring that contains a delimited set of potential matching strings for the method object string. The strings in list are separated by a separator character, which must be indicated by the first character of the argument. The separator must be non-alphanumeric. The format of list is therefore
separatorString1[separatorString2]... |
Usage notes
- The stringSet argument must be non-null or the request is cancelled.
Examples
The following are IsOneOf sample statements:
%str is longstring %str = 'bleh' printText {~} = '{%str:isOneOf('/blah/bleh/blih')}' printText {~} = '{%str:isOneOf(',blah,bleh,blih')}' printText {~} = '{%str:isOneOf('/blah/blh/blih')}'
The results are respectively:
%str:isOneOf('/blah/bleh/blih') = True %str:isOneOf(',blah,bleh,blih') = True %str:isOneOf('/blah/blh/blih') = False