Substring (StringTokenizer function) - Revision history

JAL: /* Syntax terms */

2012-11-15T20:56:11Z

Syntax terms

← Older revision		Revision as of 20:56, 15 November 2012
Line 12:		Line 12:
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string variable to contain the returned substring. </td></tr>		<td>A string variable to contain the returned substring. </td></tr>

	<tr><th>stringTokenizer</th>		<tr><th>stringTokenizer</th>
	<td>A <var>StringTokenizer</var> object expression. </td></tr>		<td>A <var>StringTokenizer</var> object expression. </td></tr>

	<tr><th>position</th>		<tr><th>position</th>
	<td>The starting byte number in the tokenizing string to return. </td></tr>		<td>The starting byte number in the tokenizing string to return. </td></tr>

	<tr><th>length</th>		<tr><th>length</th>
	<td>The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at <var class="term">position</var>), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>		<td>The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at <var class="term">position</var>), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>

	<tr><th><var>Pad</var></th>		<tr><th><var>Pad</var></th>
	<td>The character used to pad the result substring on the right if the result is shorter than the requested length. <var class="term">c</var> defaults to the null string, which means no padding is done. <var>Pad</var> is a name-required parameter.</td></tr>		<td>The character used to pad the result substring on the right if the result is shorter than the requested length. <var class="term">c</var> defaults to the null string, which means no padding is done. <var>Pad</var> is a [[Notation conventions for methods#Named parameters\|name required]] parameter.</td></tr>
	</table>		</table>

JAL2: /* Examples */

2012-07-06T01:21:24Z

Examples

← Older revision		Revision as of 01:21, 6 July 2012
Line 35:		Line 35:
	==Examples==		==Examples==

	The following request prints "<tt>nizer Substring example!!!!!</tt>":		The following request prints <code>nizer Substring example!!!!!</code>:
	<p class="code">begin		<p class="code">begin
	%tok is object stringtokenizer		%tok is object stringtokenizer
Line 41:		Line 41:
	%tok:string = 'a tokenizer Substring example'		%tok:string = 'a tokenizer Substring example'
	%sub = %tok:substring(7, 28, pad='!')		%sub = %tok:substring(7, 28, pad='!')
	printText {~} is {%tok:substring(7, 28, pad='!')}		[[Targeted Text statements\|printText]] {~} is {%tok:substring(7, 28, pad='!')}
	end		end
	</p>		</p>

JAL2: /* Usage notes */

2012-07-06T01:19:38Z

Usage notes

← Older revision		Revision as of 01:19, 6 July 2012
Line 24:		Line 24:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li><var class="term">length</var> must be a non-negative number.		<li>The <var class="term">length</var> value must be a non-negative number.
	A negative number results in request cancellation.		A negative number results in request cancellation.

	<li>The <var>Pad</var> argument must be either the null string or a single character.		<li>The <var>Pad</var> argument must be either the null string or a single character.
	A longer value results		A longer value results
Line 31:		Line 32:
	error in <var class="product">Sirius Mods</var> 7.3 and higher.		error in <var class="product">Sirius Mods</var> 7.3 and higher.
	</ul>		</ul>

	==Examples==		==Examples==

Dme at 17:07, 8 February 2012

2012-02-08T17:07:43Z

← Older revision		Revision as of 17:07, 8 February 2012
Line 17:		Line 17:
	<td>The starting byte number in the tokenizing string to return. </td></tr>		<td>The starting byte number in the tokenizing string to return. </td></tr>
	<tr><th>length</th>		<tr><th>length</th>
	<td>The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at ~~the ''start''~~ position), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>		<td>The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at <var class="term">position</var>), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>
	<tr><th><var>Pad</var></th>		<tr><th><var>Pad</var></th>
	<td>The character used to pad the result substring on the right if the result is shorter than the requested length. ~~''char''~~ defaults to a null, which means no padding is done. <var>Pad</var> is a name-required parameter.</td></tr>		<td>The character used to pad the result substring on the right if the result is shorter than the requested length. <var class="term">c</var> defaults to the null string, which means no padding is done. <var>Pad</var> is a name-required parameter.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>~~The~~ length must be a non-negative number.		<li><var class="term">length</var> must be a non-negative number.
	A negative number results in request cancellation.		A negative number results in request cancellation.
	<li>The ~~pad parameter~~ must be either null or a single character.		<li>The <var>Pad</var> argument must be either the null string or a single character.
	A longer value results		A longer value results
	in request cancellation in <var class="product">Sirius Mods</var> version 7.2 and in a compilation		in request cancellation in <var class="product">Sirius Mods</var> version 7.2 and in a compilation

JALWiccan: 1 revision

2011-05-24T22:31:14Z

1 revision

New page

{{Template:StringTokenizer:Substring subtitle}}

This function returns a substring
that is a specified length and starts at a specific position in the
tokenizing string.
The substring may be padded on the right.

==Syntax==
{{Template:StringTokenizer:Substring syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th>
<td>A string variable to contain the returned substring. </td></tr>
<tr><th>stringTokenizer</th>
<td>A <var>StringTokenizer</var> object expression. </td></tr>
<tr><th>position</th>
<td>The starting byte number in the tokenizing string to return. </td></tr>
<tr><th>length</th>
<td>The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at the ''start'' position), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>
<tr><th><var>Pad</var></th>
<td>The character used to pad the result substring on the right if the result is shorter than the requested length. ''char'' defaults to a null, which means no padding is done. <var>Pad</var> is a name-required parameter.</td></tr>
</table>

==Usage notes==
<ul>
<li>The length must be a non-negative number.
A negative number results in request cancellation.
<li>The pad parameter must be either null or a single character.
A longer value results
in request cancellation in <var class="product">Sirius Mods</var> version 7.2 and in a compilation
error in <var class="product">Sirius Mods</var> 7.3 and higher.
</ul>
==Examples==

The following request prints "<tt>nizer Substring example!!!!!</tt>":
<p class="code">begin
%tok is object stringtokenizer
%tok = new
%tok:string = 'a tokenizer Substring example'
%sub = %tok:substring(7, 28, pad='!')
printText {~} is {%tok:substring(7, 28, pad='!')}
end
</p>

==See also==
{{Template:StringTokenizer:Substring footer}}

JAL2: /* Syntax terms */

2011-04-13T02:00:58Z

Syntax terms

← Older revision		Revision as of 02:00, 13 April 2011
Line 18:		Line 18:
	<tr><th>length</th>		<tr><th>length</th>
	<td>The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at the ''start'' position), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the Pad parameter. </td></tr>		<td>The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at the ''start'' position), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the Pad parameter. </td></tr>
	<tr><th><var>Pad~~=char~~</var></th>		<tr><th><var>Pad</var></th>
	<td>The character used to pad the result substring on the right if the result is shorter than the requested length. ''char'' defaults to a null, which means no padding is done. Pad is a name-required parameter.</td></tr>		<td>The character used to pad the result substring on the right if the result is shorter than the requested length. ''char'' defaults to a null, which means no padding is done. Pad is a name-required parameter.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>

JALWiccan: 1 revision

2011-04-13T01:54:51Z

1 revision

← Older revision	Revision as of 01:54, 13 April 2011
(No difference)

Dme: /* Examples */

2011-04-13T01:54:50Z

Examples

← Older revision		Revision as of 01:54, 13 April 2011
Line 18:		Line 18:
	<tr><th>length</th>		<tr><th>length</th>
	<td>The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at the ''start'' position), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the Pad parameter. </td></tr>		<td>The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at the ''start'' position), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the Pad parameter. </td></tr>
	<tr><th>Pad=char</th>		<tr><th><var>Pad=char</var></th>
	<td>The character used to pad the result substring on the right if the result is shorter than the requested length. ''char'' defaults to a null, which means no padding is done. Pad is a name-required parameter.</td></tr>		<td>The character used to pad the result substring on the right if the result is shorter than the requested length. ''char'' defaults to a null, which means no padding is done. Pad is a name-required parameter.</td></tr>
	</table>		</table>

Dme: /* Examples */

2011-02-06T22:29:58Z

Examples

← Older revision		Revision as of 22:29, 6 February 2011
Line 32:		Line 32:
	==Examples==		==Examples==

	The following request prints "<tt>nizer ~~<var>~~Substring~~</var>~~ example!!!!!</tt>":		The following request prints "<tt>nizer Substring example!!!!!</tt>":
	<p class="code">begin		<p class="code">begin
	%tok is object stringtokenizer		%tok is object stringtokenizer
	%tok = new		%tok = new
	%tok:string = 'a tokenizer ~~<var>~~Substring~~</var>~~ example'		%tok:string = 'a tokenizer Substring example'
	%sub = %tok:substring(7, 28, pad='!')		%sub = %tok:substring(7, 28, pad='!')
	printText {~} is {%tok:substring(7, 28, pad='!')}		printText {~} is {%tok:substring(7, 28, pad='!')}
	end		end
	</p>		</p>

	==See also==		==See also==
	{{Template:StringTokenizer:Substring footer}}		{{Template:StringTokenizer:Substring footer}}

Wiccan: 1 revision

2011-02-06T21:48:06Z

1 revision

← Older revision	Revision as of 21:48, 6 February 2011
(No difference)