IsOneOf (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (first pass, match syntax diagram to template and fix tags)
Line 1: Line 1:
{{Template:String:IsOneOf subtitle}}
{{Template:String:IsOneOf subtitle}}


This [[Intrinsic classes|intrinsic]] function returns a <var>Boolean</var> value that indicates whether the method object
<var>IsOneOf</var> is an [[Intrinsic classes|intrinsic]] function that returns a <var>Boolean</var> value that indicates whether the method object string is matched by one of the strings in an input <var class="term">list</var> of strings. The input <var class="term">list</var> of strings is concatenated in a single delimited string argument to the method. A returned value of <code>True</code> signals a successful match.
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 <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>.
==Syntax==
==Syntax==
{{Template:String:IsOneOf syntax}}
{{Template:String:IsOneOf syntax}}
Line 12: Line 8:
<table class="syntaxTable">
<table class="syntaxTable">
<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>string</th>
<tr><th><var class="term">string</var></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>list</th>
<tr><th><var class="term">list</var></th>
<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
<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">separator<var>String</var>1[separatorString2]...</p></td></tr>
<p class="syntax"><i>separatorString1[separatorString2][separatorString3]...</i></p></td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
*The ''stringSet'' argument must be non-null or the request is cancelled.
<ul><li>The <var class="term">list</var> argument must be non-null or the request is cancelled.
<li><var>IsOneOf</var> is available as of <var class="product">Sirius Mods</var> version 7.3.</ul>
 
==Examples==
==Examples==
 
<ol><li>The following are <var>IsOneOf</var> sample statements:
The following are <var>IsOneOf</var> sample statements:
<p class="code">%str is longstring
<p class="code">%str is longstring
%str = 'bleh'
%str = 'bleh'
[[Intrinsic classes#printtext|printText]] {~} = '{%str:isOneOf('/blah/bleh/blih')}'
printText {~} = '{%str:isOneOf('/blah/bleh/blih')}'
printText {~} = '{%str:isOneOf(',blah,bleh,blih')}'
printText {~} = '{%str:isOneOf(',blah,bleh,blih')}'
printText {~} = '{%str:isOneOf('/blah/blh/blih')}'
printText {~} = '{%str:isOneOf('/blah/blh/blih')}'
Line 35: Line 32:
%str:isOneOf(',blah,bleh,blih') = True
%str:isOneOf(',blah,bleh,blih') = True
%str:isOneOf('/blah/blh/blih') = False
%str:isOneOf('/blah/blh/blih') = False
</p>[[Category:String methods|IsOneOf function]]
</p>
</ol>
 
[[Category:String methods|IsOneOf function]]
==See also==
==See also==
<ul><li>For details of the <var>printtext</var> statement, please see [[Intrinsic classes#printtext|printText]]</ul>
{{Template:String:IsOneOf footer}}
{{Template:String:IsOneOf footer}}

Revision as of 06:41, 31 January 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

  1. 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
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=IsOneOf_(String_function)&oldid=1055"