IsOneOf (String function): Difference between revisions
m (1 revision) |
m (1 revision) |
||
Line 10: | Line 10: | ||
{{Template:String:IsOneOf syntax}} | {{Template:String:IsOneOf syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%bool </th> | ||
< | <td>An enumeration object of type Boolean to contain the returned value of IsOneOf. </td></tr> | ||
< | <tr><th>string </th> | ||
< | <td>The string to which the method is applied, the maximum length of which is 255 bytes. </td></tr> | ||
< | <tr><th>stringSet </th> | ||
< | <td>A longstring that contains a delimited set of potential matching strings for the method object string. The strings in ''stringSet'' 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 ''stringSet'' is therefore ''separatorString1[separatorString2]...''.</td></tr> | ||
for the method object string. | </table> | ||
The strings in ''stringSet'' 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 ''stringSet'' is therefore | |||
''separatorString1[separatorString2]...''. | |||
</ | |||
==Usage notes== | ==Usage notes== | ||
*The ''stringSet'' argument must be non-null or the request is cancelled. | *The ''stringSet'' argument must be non-null or the request is cancelled. |
Revision as of 05:39, 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
%bool | 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. |
stringSet | A longstring that contains a delimited set of potential matching strings for the method object string. The strings in stringSet 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 stringSet 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