UnicodeSubstring (Unicode function) - Revision history

JAL at 17:43, 6 November 2012

2012-11-06T17:43:57Z

← Older revision		Revision as of 17:43, 6 November 2012
Line 1:		Line 1:
	{{Template:Unicode:UnicodeSubstring subtitle}}		{{Template:Unicode:UnicodeSubstring subtitle}}

	<var>UnicodeSubstring</var> returns a specific number of characters, starting at a specific position, from the method object <var>Unicode</var> string, possibly padding it on the right.		<var>UnicodeSubstring</var> returns a specific number of characters, starting at a specific position, from the method object <var>Unicode</var> string, possibly padding it on the right.

	==Syntax==		==Syntax==
	{{Template:Unicode:UnicodeSubstring syntax}}		{{Template:Unicode:UnicodeSubstring syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outUnicode</th>		<tr><th>%outUnicode</th>
	<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeSubstring</var> method. </td></tr>		<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeSubstring</var> method. </td></tr>

	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string. </td></tr>

	<tr><th>position</th>		<tr><th>position</th>
	<td>The character position in the method object that is the starting point of the substring that is returned. The first character from the left in the method object is position <code>1</code>.</td></tr>		<td>The character position in the method object that is the starting point of the substring that is returned. The first character from the left in the method object is position <code>1</code>.</td></tr>

	<tr><th>length</th>		<tr><th>length</th>
	<td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>		<td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> 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 string on the right if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<~~code~~><nowiki>''</nowiki></~~code~~>), which means no padding is done. <var>Pad</var> is a ~~<var>~~[[~~Methods~~#Named parameters\|~~NameRequired~~]]~~</var>~~ parameter.</td></tr>		<td>The character used to pad the result string on the right if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<tt><nowiki>''</nowiki></tt>), which means no padding is done. <var>Pad</var> is a [[Notation conventions for methods#Named parameters\|name required]] parameter.</td></tr>
	</table>		</table>

Line 21:		Line 27:
	<ul>		<ul>
	<li>The <var class="term">length</var> must be a non-negative number. A negative <var class="term">length</var> results in request cancellation.		<li>The <var class="term">length</var> must be a non-negative number. A negative <var class="term">length</var> results in request cancellation.
	<li>The <var ~~class="term"~~>~~pad~~</var> parameter must be either null or a single character. A longer value results in a compilation error.		<li>The <var>Pad</var> parameter must be either null or a single character. A longer value results in a compilation error.
	<li>If the starting <var class="term">position</var> is known to be 1, it might be tidier and slightly more efficient to use the <var>UnicodeLeft</var> method instead of <var>UnicodeSubstring</var>.		<li>If the starting <var class="term">position</var> is known to be 1, it might be tidier and slightly more efficient to use the <var>UnicodeLeft</var> method instead of <var>UnicodeSubstring</var>.
	<li><var>UnicodeSubstring</var> is available as of <var class="product">[[Sirius Mods~~\|Sirius Mods]]~~</var> Version 7.5.		<li><var>UnicodeSubstring</var> is available as of <var class="product">Sirius Mods</var> Version 7.5.
	</ul>		</ul>

	==Examples==		==Examples==
	<ol><li>The following statement places into <code>%y</code> the 5 characters of <code>%x</code> starting at the third character. If <code>%x</code> is shorter than 7 characters, then all of <code>%x</code> is copied into <code>%y</code>:		<ol>
			<li>The following statement places into <code>%y</code> the 5 characters of <code>%x</code> starting at the third character. If <code>%x</code> is shorter than 7 characters, then all of <code>%x</code> is copied into <code>%y</code>:
	<p class="code">%y = %x:unicodeSubstring(3, 5)		<p class="code">%y = %x:unicodeSubstring(3, 5)
	</p>		</p>

	<li>The following statement displays <code>C?!</code>:		<li>The following statement displays <code>C?!</code>:
	<p class="code">%u is unicode initial('ABC&#xA1;':[[U (String function)\|U]])		<p class="code">%u is unicode initial('ABC&#xA1;':[[U (String function)\|U]])
Line 38:		Line 46:

	==See also==		==See also==
	<ul><li><var>UnicodeSubstring</var> is analogous to the intrinsic <var>[[String class\|String]]</var> method: <var>[[Substring (String function)\|Substring]]</var>.</ul>		<ul>
			<li><var>UnicodeSubstring</var> is analogous to the intrinsic <var>[[String class\|String]]</var> method: <var>[[Substring (String function)\|Substring]]</var>.</ul>

	{{Template:Unicode:UnicodeSubstring footer}}		{{Template:Unicode:UnicodeSubstring footer}}

JALWiccan: 1 revision

2012-11-06T17:32:26Z

1 revision

← Older revision	Revision as of 17:32, 6 November 2012
(No difference)

JAL2 at 17:32, 6 November 2012

2012-11-06T17:32:25Z

← Older revision		Revision as of 17:32, 6 November 2012
Line 31:		Line 31:
	</p>		</p>
	<li>The following statement displays <code>C?!</code>:		<li>The following statement displays <code>C?!</code>:
	<p class="code">%u is unicode initial('ABC&~~amp;amp;~~amp;#xA1;':[[U (String function)\|U]])		<p class="code">%u is unicode initial('ABC&#xA1;':[[U (String function)\|U]])
	[[Intrinsic classes#printtext\|printText]] {%u:unicodeSubstring(3,3, pad='!')}		[[Intrinsic classes#printtext\|printText]] {%u:unicodeSubstring(3,3, pad='!')}
	</p>		</p>

JAL2 at 22:10, 7 August 2012

2012-08-07T22:10:34Z

← Older revision		Revision as of 22:10, 7 August 2012
Line 13:		Line 13:
	<td>The character position in the method object that is the starting point of the substring that is returned. The first character from the left in the method object is position <code>1</code>.</td></tr>		<td>The character position in the method object that is the starting point of the substring that is returned. The first character from the left in the method object is position <code>1</code>.</td></tr>
	<tr><th>length</th>		<tr><th>length</th>
	<td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> is returned with no padding, depending on the value of the <var ~~class="term"~~>Pad</var> parameter. </td></tr>		<td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> 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 string on the right if it is shorter than the requested length. <var ~~class="term"~~>Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var ~~class="term"~~>Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>		<td>The character used to pad the result string on the right if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var>Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>
	</table>		</table>

JALWiccan: 1 revision

2011-05-04T17:46:37Z

1 revision

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

JALWiccan: 1 revision

2011-05-04T17:46:35Z

1 revision

← Older revision		Revision as of 17:46, 4 May 2011
Line 23:		Line 23:
	<li>The <var class="term">pad</var> parameter must be either null or a single character. A longer value results in a compilation error.		<li>The <var class="term">pad</var> parameter must be either null or a single character. A longer value results in a compilation error.
	<li>If the starting <var class="term">position</var> is known to be 1, it might be tidier and slightly more efficient to use the <var>UnicodeLeft</var> method instead of <var>UnicodeSubstring</var>.		<li>If the starting <var class="term">position</var> is known to be 1, it might be tidier and slightly more efficient to use the <var>UnicodeLeft</var> method instead of <var>UnicodeSubstring</var>.
	<li><var>UnicodeSubstring</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.		<li><var>UnicodeSubstring</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.5.
	</ul>		</ul>

Line 31:		Line 31:
	</p>		</p>
	<li>The following statement displays <code>C?!</code>:		<li>The following statement displays <code>C?!</code>:
	<p class="code">%u is unicode initial('ABC&amp;#xA1;':[[U (String function)\|U]])		<p class="code">%u is unicode initial('ABC&amp;amp;#xA1;':[[U (String function)\|U]])
	[[Intrinsic classes#printtext\|printText]] {%u:unicodeSubstring(3,3, pad='!')}		[[Intrinsic classes#printtext\|printText]] {%u:unicodeSubstring(3,3, pad='!')}
	</p>		</p>

JALWiccan: 1 revision

2011-04-13T00:55:37Z

1 revision

← Older revision	Revision as of 00:55, 13 April 2011
(No difference)

Goff: see also

2011-04-13T00:55:35Z

Goff: see also

2011-03-14T00:37:40Z

JAL at 23:10, 28 February 2011

2011-02-28T23:10:02Z

← Older revision		Revision as of 23:10, 28 February 2011
Line 15:		Line 15:
	<td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> is returned with no padding, depending on the value of the <var class="term">Pad</var> parameter. </td></tr>		<td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> is returned with no padding, depending on the value of the <var class="term">Pad</var> parameter. </td></tr>
	<tr><th>Pad</th>		<tr><th>Pad</th>
	<td>The character used to pad the result string on the right if it is shorter than the requested length. <var class="term">Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var class="term">Pad</var> is a <var>[[Methods#Named parameters\|~~Name-Required~~]]</var> parameter.</td></tr>		<td>The character used to pad the result string on the right if it is shorter than the requested length. <var class="term">Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var class="term">Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>
	</table>		</table>

Line 22:		Line 22:
	<li>The <var class="term">length</var> must be a non-negative number. A negative <var class="term">length</var> results in request cancellation.		<li>The <var class="term">length</var> must be a non-negative number. A negative <var class="term">length</var> results in request cancellation.
	<li>The <var class="term">pad</var> parameter must be either null or a single character. A longer value results in a compilation error.		<li>The <var class="term">pad</var> parameter must be either null or a single character. A longer value results in a compilation error.
	<li>If the <var class="term">~~start~~</var> ~~position~~ is known to be 1, it might be tidier and slightly more efficient to use the <var>UnicodeLeft</var> method instead of <var>UnicodeSubstring</var>.		<li>If the starting <var class="term">position</var> is known to be 1, it might be tidier and slightly more efficient to use the <var>UnicodeLeft</var> method instead of <var>UnicodeSubstring</var>.
	<li><var>UnicodeSubstring</var> method is analogous to the intrinsic <var>[[String class\|String]]</var> method: <var>[[Substring (String function)\|Substring]]</var>.		<li>The <var>UnicodeSubstring</var> method is analogous to the intrinsic <var>[[String class\|String]]</var> method: <var>[[Substring (String function)\|Substring]]</var>.
	<li><var>UnicodeSubstring</var> ~~function~~ is available as of <var class="product">[[Sirius Mods~~\|"Sirius Mods"~~]]</var> Version 7.5.		<li><var>UnicodeSubstring</var> is available as of <var class="product">[[Sirius Mods]]</var> Version 7.5.
	</ul>		</ul>

	==Examples==		==Examples==
	<ol><li>The following statement places into %y the 5 characters of %x starting at the third character. If %x is shorter than 7 characters, then all of %x is copied into %y:		<ol><li>The following statement places into <code>%y</code> the 5 characters of <code>%x</code> starting at the third character. If <code>%x</code> is shorter than 7 characters, then all of <code>%x</code> is copied into <code>%y</code>:
	<p class="code">%y = %x:unicodeSubstring(3, 5)		<p class="code">%y = %x:unicodeSubstring(3, 5)
	</p>		</p>

← Older revision		Revision as of 00:55, 13 April 2011
Line 14:		Line 14:
	<tr><th>length</th>		<tr><th>length</th>
	<td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> is returned with no padding, depending on the value of the <var class="term">Pad</var> parameter. </td></tr>		<td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> is returned with no padding, depending on the value of the <var class="term">Pad</var> parameter. </td></tr>
	<tr><th>Pad</th>		<tr><th><var>Pad</var></th>
	<td>The character used to pad the result string on the right if it is shorter than the requested length. <var class="term">Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var class="term">Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>		<td>The character used to pad the result string on the right if it is shorter than the requested length. <var class="term">Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var class="term">Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>
	</table>		</table>
Line 31:		Line 31:
	</p>		</p>
	<li>The following statement displays <code>C?!</code>:		<li>The following statement displays <code>C?!</code>:
	<p class="code">%u is unicode initial('ABC&#xA1;':[[U (String function)\|U]])		<p class="code">%u is unicode initial('ABC&amp;#xA1;':[[U (String function)\|U]])
	[[Intrinsic classes#printtext\|printText]] {%u:unicodeSubstring(3,3, pad='!')}		[[Intrinsic classes#printtext\|printText]] {%u:unicodeSubstring(3,3, pad='!')}
	</p>		</p>

← Older revision		Revision as of 00:37, 14 March 2011
Line 1:		Line 1:
	{{Template:Unicode:UnicodeSubstring subtitle}}		{{Template:Unicode:UnicodeSubstring subtitle}}
	<var>UnicodeSubstring</var> returns a specific number of characters starting at a specific position in the method object <var>Unicode</var> string, possibly padding it on the right.		<var>UnicodeSubstring</var> returns a specific number of characters, starting at a specific position, from the method object <var>Unicode</var> string, possibly padding it on the right.

	==Syntax==		==Syntax==
Line 23:		Line 23:
	<li>The <var class="term">pad</var> parameter must be either null or a single character. A longer value results in a compilation error.		<li>The <var class="term">pad</var> parameter must be either null or a single character. A longer value results in a compilation error.
	<li>If the starting <var class="term">position</var> is known to be 1, it might be tidier and slightly more efficient to use the <var>UnicodeLeft</var> method instead of <var>UnicodeSubstring</var>.		<li>If the starting <var class="term">position</var> is known to be 1, it might be tidier and slightly more efficient to use the <var>UnicodeLeft</var> method instead of <var>UnicodeSubstring</var>.
	~~<li>The <var>UnicodeSubstring</var> method is analogous to the intrinsic <var>[[String class\|String]]</var> method: <var>[[Substring (String function)\|Substring]]</var>.~~		<li><var>UnicodeSubstring</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.
	<li><var>UnicodeSubstring</var> is available as of <var class="product">[[Sirius Mods]]</var> Version 7.5.
	</ul>		</ul>

Line 39:		Line 38:

	==See also==		==See also==
			<ul><li><var>UnicodeSubstring</var> is analogous to the intrinsic <var>[[String class\|String]]</var> method: <var>[[Substring (String function)\|Substring]]</var>.</ul>
	{{Template:Unicode:UnicodeSubstring footer}}		{{Template:Unicode:UnicodeSubstring footer}}