UnicodeLeft (Unicode function) - Revision history

JAL: misc formatting

2017-07-11T18:31:04Z

misc formatting

← Older revision		Revision as of 18:31, 11 July 2017
Line 17:		Line 17:

	<tr><th><var>Pad</var></th>		<tr><th><var>Pad</var></th>
	<td>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">c</var> defaults to a null string (<tt><nowiki>''</nowiki></tt>) which means no padding is done. <var>Pad</var> is a Unicode string~~; like~~ all Unicode arguments, if an EBCDIC string is specified, it is converted to ~~Unicode.~~		<td>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">c</var> defaults to a 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>		<p>
			<var>Pad</var> is a [[Notation conventions for methods#Named parameters\|name required]] parameter, and <var>Pad</var> is a <var>Unicode</var> string. Like all <var>Unicode</var> arguments, if an EBCDIC string is specified, it is, converted to <var>Unicode</var>. </p></td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.		<li>The <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation. </li>
	<li>The <var>Pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.
	<li><var>UnicodeLeft</var> is ~~available~~ as of <var ~~class="product"~~>~~Sirius Mods~~</var> ~~Version 7.5~~.		<li>The <var>Pad</var> parameter value must be either null or a single character. A longer value results in a compilation error. </li>

			<li><var>UnicodeLeft</var> is identical to <var>[[UnicodeSubstring (Unicode function)\|UnicodeSubstring]]</var> with <code>1</code> as its first argument. </li>

			<li><var>UnicodeLeft</var> is analogous to the <var>[[Left (String function)\|Left]]</var> <var>String</var> intrinsic method. </li>
	</ul>		</ul>

Line 46:		Line 51:

	==See also==		==See also==
	~~<ul><li><var>UnicodeLeft</var> is identical to the <var>[[UnicodeSubstring (Unicode function)\|UnicodeSubstring]]</var> with a 1 for the first argument.~~
	~~<li><var>UnicodeLeft</var> is analogous to the <var>[[Left (String function)\|Left]]</var> <var>String</var> intrinsic method.~~
	~~</ul>~~
	{{Template:Unicode:UnicodeLeft footer}}		{{Template:Unicode:UnicodeLeft footer}}

Dme: /* Syntax terms */

2017-07-05T11:58:22Z

Syntax terms

← Older revision		Revision as of 11:58, 5 July 2017
Line 17:		Line 17:

	<tr><th><var>Pad</var></th>		<tr><th><var>Pad</var></th>
	<td>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">c</var> defaults to a 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>		<td>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">c</var> defaults to a null string (<tt><nowiki>''</nowiki></tt>) which means no padding is done. <var>Pad</var> is a Unicode string; like all Unicode arguments, if an EBCDIC string is specified, it is converted to Unicode.
			<var>Pad</var> is a [[Notation conventions for methods#Named parameters\|name required]] parameter.</td></tr>
	</table>		</table>

JAL: /* Usage notes */

2012-11-06T17:21:21Z

Usage notes

← Older revision		Revision as of 17:21, 6 November 2012
Line 23:		Line 23:
	<ul>		<ul>
	<li>The <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.		<li>The <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.
	<li>The <var ~~class="term"~~>~~pad~~</var> parameter value must be either null or a single character. A longer value results in a compilation error.		<li>The <var>Pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.
	<li><var>UnicodeLeft</var> is available as of <var class="product">Sirius Mods</var> Version 7.5.		<li><var>UnicodeLeft</var> is available as of <var class="product">Sirius Mods</var> Version 7.5.
	</ul>		</ul>

JAL at 17:21, 6 November 2012

2012-11-06T17:21:01Z

← Older revision		Revision as of 17:21, 6 November 2012
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:Unicode:UnicodeLeft syntax}}		{{Template:Unicode:UnicodeLeft 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>UnicodeLeft</var> method. </td></tr>		<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeLeft</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>number</th>		<tr><th>number</th>
	<td>The number of the left-most characters to return. If <var class="term">unicode</var> is shorter than the requested number of characters, it is either padded to the requested length or returned with no padding, depending on the value of the <var ~~class="term"~~>~~pad~~</var> parameter. </td></tr>		<td>The number of the left-most characters to return. If <var class="term">unicode</var> is shorter than the requested number of characters, it is either padded to the requested length or 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>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">~~pad~~</var> defaults to a null string (<~~code~~><nowiki>''</nowiki></~~code~~>) which means no padding is done. <var ~~class="term"~~>~~pad~~</var> is a [[~~Methods~~#Named parameters\|name required]] parameter.</td></tr>		<td>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">c</var> defaults to a 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>

	==Usage notes==		==Usage notes==
	<ul><li>The <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.		<ul>
			<li>The <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.
	<li>The <var class="term">pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.		<li>The <var class="term">pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.
	<li><var>UnicodeLeft</var> is available as of <var class="product">[[Sirius Mods~~\|Sirius Mods]]~~</var> Version 7.5.</ul>		<li><var>UnicodeLeft</var> is available as of <var class="product">Sirius Mods</var> Version 7.5.
			</ul>

	==Examples==		==Examples==
	<ol><li>The following statement displays <code>Model 2</code>:		<ol>
	<p class="code">%u is unicode initial('Model 204&~~amp;amp;amp;~~amp;#x2122;':[[U (String function)\|U]])		<li>The following statement displays <code>Model 2</code>:
			<p class="code">%u is unicode initial('Model 204&#x2122;':[[U (String function)\|U]])
	[[Intrinsic classes#printtext\|printText]] {%u:unicodeLeft(7)}		[[Intrinsic classes#printtext\|printText]] {%u:unicodeLeft(7)}
	</p>		</p>

	<li>The following statement displays <code>Model 204!!!</code>:		<li>The following statement displays <code>Model 204!!!</code>:
	<p class="code">%u is unicode initial('Model 204')		<p class="code">%u is unicode initial('Model 204')
	printText {%u:unicodeLeft(12, pad='!')}		printText {%u:unicodeLeft(12, pad='!')}
	</p>		</p>
	<li>The following statement gets a character translation exception because the <var>Unicode</var> character <code>&~~amp;amp;amp;~~amp;#x2122;</code> (trademark) has no ~~Ebcdic~~ equivalent:
	<p class="code">%u is unicode initial('Model 204&~~amp;amp;amp;~~amp;#x2122;':U)		<li>The following statement gets a character translation exception because the <var>Unicode</var> character <code>&#x2122;</code> (trademark) has no EBCDIC equivalent:
			<p class="code">%u is unicode initial('Model 204&#x2122;':U)
	printText {%u:unicodeLeft(10)}		printText {%u:unicodeLeft(10)}
	</p></ol>		</p></ol>

JAL2: /* Syntax terms */

2011-05-04T22:04:40Z

Syntax terms

← Older revision		Revision as of 22:04, 4 May 2011
Line 13:		Line 13:
	<td>The number of the left-most characters to return. If <var class="term">unicode</var> is shorter than the requested number of characters, it is either padded to the requested length or returned with no padding, depending on the value of the <var class="term">pad</var> parameter. </td></tr>		<td>The number of the left-most characters to return. If <var class="term">unicode</var> is shorter than the requested number of characters, it is either padded to the requested length or returned with no padding, depending on the value of the <var class="term">pad</var> parameter. </td></tr>
	<tr><th><var>Pad</var></th>		<tr><th><var>Pad</var></th>
	<td>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">pad</var> defaults to a 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>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">pad</var> defaults to a null string (<code><nowiki>''</nowiki></code>) which means no padding is done. <var class="term">pad</var> is a [[Methods#Named parameters\|name required]] parameter.</td></tr>
	</table>		</table>

JALWiccan: 1 revision

2011-05-04T19:38:03Z

1 revision

← Older revision	Revision as of 19:38, 4 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-04T19:38:02Z

1 revision

← Older revision		Revision as of 19:38, 4 May 2011
Line 13:		Line 13:
	<td>The number of the left-most characters to return. If <var class="term">unicode</var> is shorter than the requested number of characters, it is either padded to the requested length or returned with no padding, depending on the value of the <var class="term">pad</var> parameter. </td></tr>		<td>The number of the left-most characters to return. If <var class="term">unicode</var> is shorter than the requested number of characters, it is either padded to the requested length or returned with no padding, depending on the value of the <var class="term">pad</var> parameter. </td></tr>
	<tr><th><var>Pad</var></th>		<tr><th><var>Pad</var></th>
	<td>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">pad</var> defaults to a 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>A single character used to pad <var class="term">unicode</var>, on the right, if it is shorter than the requested <var class="term">number</var>. <var class="term">pad</var> defaults to a 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>
	</table>		</table>

Line 23:		Line 23:
	==Examples==		==Examples==
	<ol><li>The following statement displays <code>Model 2</code>:		<ol><li>The following statement displays <code>Model 2</code>:
	<p class="code">%u is unicode initial('Model 204&amp;amp;#x2122;':[[U (String function)\|U]])		<p class="code">%u is unicode initial('Model 204&amp;amp;amp;#x2122;':[[U (String function)\|U]])
	[[Intrinsic classes#printtext\|printText]] {%u:unicodeLeft(7)}		[[Intrinsic classes#printtext\|printText]] {%u:unicodeLeft(7)}
	</p>		</p>
Line 30:		Line 30:
	printText {%u:unicodeLeft(12, pad='!')}		printText {%u:unicodeLeft(12, pad='!')}
	</p>		</p>
	<li>The following statement gets a character translation exception because the <var>Unicode</var> character <code>&amp;amp;#x2122;</code> (trademark) has no Ebcdic equivalent:		<li>The following statement gets a character translation exception because the <var>Unicode</var> character <code>&amp;amp;amp;#x2122;</code> (trademark) has no Ebcdic equivalent:
	<p class="code">%u is unicode initial('Model 204&amp;amp;#x2122;':U)		<p class="code">%u is unicode initial('Model 204&amp;amp;amp;#x2122;':U)
	printText {%u:unicodeLeft(10)}		printText {%u:unicodeLeft(10)}
	</p></ol>		</p></ol>

JALWiccan: 1 revision

2011-05-04T17:46:36Z

1 revision

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

JALWiccan: 1 revision

2011-05-04T17:46:35Z

1 revision

JALWiccan: 1 revision

2011-04-13T00:55:36Z

1 revision

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

← Older revision		Revision as of 17:46, 4 May 2011
Line 19:		Line 19:
	<ul><li>The <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.		<ul><li>The <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.
	<li>The <var class="term">pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.		<li>The <var class="term">pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.
	<li><var>UnicodeLeft</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.</ul>		<li><var>UnicodeLeft</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.5.</ul>

	==Examples==		==Examples==
	<ol><li>The following statement displays <code>Model 2</code>:		<ol><li>The following statement displays <code>Model 2</code>:
	<p class="code">%u is unicode initial('Model 204&amp;#x2122;':[[U (String function)\|U]])		<p class="code">%u is unicode initial('Model 204&amp;amp;#x2122;':[[U (String function)\|U]])
	[[Intrinsic classes#printtext\|printText]] {%u:unicodeLeft(7)}		[[Intrinsic classes#printtext\|printText]] {%u:unicodeLeft(7)}
	</p>		</p>
Line 30:		Line 30:
	printText {%u:unicodeLeft(12, pad='!')}		printText {%u:unicodeLeft(12, pad='!')}
	</p>		</p>
	<li>The following statement gets a character translation exception because the <var>Unicode</var> character <code>&amp;#x2122;</code> (trademark) has no Ebcdic equivalent:		<li>The following statement gets a character translation exception because the <var>Unicode</var> character <code>&amp;amp;#x2122;</code> (trademark) has no Ebcdic equivalent:
	<p class="code">%u is unicode initial('Model 204&amp;#x2122;':U)		<p class="code">%u is unicode initial('Model 204&amp;amp;#x2122;':U)
	printText {%u:unicodeLeft(10)}		printText {%u:unicodeLeft(10)}
	</p></ol>		</p></ol>