IsOneOf (String function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
Line 6: | Line 6: | ||
A returned value of ''''True'''' signals a successful match. | A returned value of ''''True'''' signals a successful match. | ||
The IsOneOf 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>. | ||
==Syntax== | ==Syntax== | ||
{{Template:String:IsOneOf syntax}} | {{Template:String:IsOneOf syntax}} | ||
Line 12: | Line 12: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%bool </th> | <tr><th>%bool </th> | ||
<td>An enumeration object of type Boolean to contain the returned value of IsOneOf. </td></tr> | <td>An enumeration object of type Boolean 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> | ||
Line 23: | Line 23: | ||
==Examples== | ==Examples== | ||
The following are IsOneOf sample statements: | The following are <var>IsOneOf</var> sample statements: | ||
%str is longstring | %str is longstring | ||
%str = 'bleh' | %str = 'bleh' |
Revision as of 15:32, 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