IsOneOf (String function) - Revision history

Dme: /* Usage notes */

2013-02-04T18:29:45Z

Usage notes

← Older revision		Revision as of 18:29, 4 February 2013
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul><li>The <var class="term">list</var> 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\|Sirius Mods]]</var> version 7.3.</ul>		<li><var>IsOneOf</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.3.
			<li>If the method object <var class="term">string</var> is known to be a single character, then a slightly more efficient approach is to use <var>[[PositionIn (String function)\|PositionIn]]</var>, for example:
			<p class="code">%c is string len 1
			...
			if %c:PositionIn('0123456789') then
			* Handle numeric digit:
			...
			end if
			</p>
			</ul>

	==Examples==		==Examples==

JAL: /* Examples */

2012-11-02T21:04:47Z

Examples

← Older revision		Revision as of 21:04, 2 November 2012
Line 21:		Line 21:

	==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'
Line 33:		Line 33:
	%str:isOneOf('/blah/blh/blih') = False		%str:isOneOf('/blah/blh/blih') = False
	</p>		</p>
	~~</ol>~~

	[[Category:String methods\|IsOneOf function]]		[[Category:String methods\|IsOneOf function]]

	==See also==		==See also==
	{{Template:String:IsOneOf footer}}		{{Template:String:IsOneOf footer}}

JALWiccan: 1 revision

2011-05-04T17:46:26Z

1 revision

← Older revision	Revision as of 17:46, 4 May 2011
(No difference)

Goff: printtext

2011-05-04T17:46:25Z

printtext

← Older revision		Revision as of 17:46, 4 May 2011
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul><li>The <var class="term">list</var> 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\|"Sirius Mods"]]</var> version 7.3.</ul>		<li><var>IsOneOf</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.3.</ul>

	==Examples==		==Examples==

Goff: printtext

2011-02-22T11:42:26Z

printtext

← Older revision		Revision as of 11:42, 22 February 2011
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul><li>The <var class="term">list</var> 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>		<li><var>IsOneOf</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> version 7.3.</ul>

	==Examples==		==Examples==
Line 24:		Line 24:
	<p class="code">%str is longstring		<p class="code">%str is longstring
	%str = 'bleh'		%str = 'bleh'
	printText {~} = '{%str:isOneOf('/blah/bleh/blih')}'		[[PrintText statement\|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 37:		Line 37:
	[[Category:String methods\|IsOneOf function]]		[[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}}

Goff: Full stop

2011-02-03T23:23:03Z

Full stop

← Older revision		Revision as of 23:23, 3 February 2011
Line 37:		Line 37:
	[[Category:String methods\|IsOneOf function]]		[[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>		<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}}

Goff: re-match syntax diagram to revised template; fix tags.

2011-02-02T03:20:58Z

re-match syntax diagram to revised template; fix tags.

← Older revision		Revision as of 03:20, 2 February 2011
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~~><var class="term"~~>string~~</var>~~</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~~><var class="term"~~>list~~</var>~~</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>

Goff: first pass, match syntax diagram to template and fix tags

2011-01-31T06:41:04Z

first pass, match syntax diagram to template and fix tags

← Older revision		Revision as of 06:41, 31 January 2011
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}}

Wiccan: 1 revision

2011-01-26T20:01:29Z

1 revision

← Older revision	Revision as of 20:01, 26 January 2011
(No difference)

Wiccan: 1 revision

2011-01-26T20:01:27Z

1 revision

← Older revision		Revision as of 20:01, 26 January 2011
Line 36:		Line 36:
	%str:isOneOf('/blah/blh/blih') = False		%str:isOneOf('/blah/blh/blih') = False
	</p>[[Category:String methods\|IsOneOf function]]		</p>[[Category:String methods\|IsOneOf function]]
	~~[[Category~~:~~Intrinsic methods]]~~		==See also==
			{{Template:String:IsOneOf footer}}