IsOneOf (String function): Difference between revisions
m (first pass, match syntax diagram to template and fix tags) |
m (re-match syntax diagram to revised template; fix tags.) |
||
Line 9: | Line 9: | ||
<tr><th>%boolean</th> | <tr><th>%boolean</th> | ||
<td>An enumeration object of type <var>Boolean</var> 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 | <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 string that contains a delimited set of potential matching strings for the method object <var class="term">string</var>. 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: | <td>A string that contains a delimited set of potential matching strings for the method object <var class="term">string</var>. 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"><i>separatorString1[separatorString2][separatorString3]...</i></p></td></tr> | <p class="syntax"><i>separatorString1[separatorString2][separatorString3]...</i></p></td></tr> |
Revision as of 03:20, 2 February 2011
Is the method object string matched by any of the strings in the input list? (String class)
IsOneOf is an intrinsic function that 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 string argument to the method. A returned value of True
signals a successful match.
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 string 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][separatorString3]... |
Usage notes
- The list argument must be non-null or the request is cancelled.
- IsOneOf is available as of Sirius Mods version 7.3.
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
See also
- For details of the printtext statement, please see printText