Left (String function) - Revision history

JAL: misc formatting

2017-07-11T18:08:54Z

misc formatting

← Older revision		Revision as of 18:08, 11 July 2017
Line 7:		Line 7:

	===Syntax terms===		===Syntax terms===
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>%outString</th>		<tr><th>%outString</th>
	<td>A variable to receive the string result of the <var>Left</var> method.</td></tr>		<td>A variable to receive the string result of the <var>Left</var> method.</td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>The input, method object <var class="term">string</var> to which the method is applied.</td></tr>		<td>The input, method object <var class="term">string</var> to which the method is applied.</td></tr>

	<tr><th>length</th>		<tr><th>length</th>
	<td>The number of the left-most bytes to return. If the method object is shorter than the requested number of bytes, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var>Pad</var> parameter.</td></tr>		<td>The number of the left-most bytes to return. If the method object is shorter than the requested number of bytes, it is either padded to the requested length or the entire method object string 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>This optional, [[Notation conventions for methods#Named parameters\|name required]], parameter is the character used to pad the method object string on the right if it is shorter than the requested length. <var class="term">c</var> defaults to a blank. If set to null, no padding is applied.		<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], parameter is the character used to pad the method object string on the right if it is shorter than the requested length. <var class="term">c</var> defaults to a blank. If set to null, no padding is applied.
Line 20:		Line 23:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The <var class="term">length</var> value must be a non-negative number. A negative number results in request cancellation.		<li>The <var class="term">length</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 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.~~
	<li><var>Left</var> is identical to the <var>[[Substring (String function)\|Substring]]</var> method with ~~a 1 for the first argument.~~		<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>Left~~</~~var~~> ~~is available~~ as ~~of <var class="product">Sirius Mods~~</~~var~~> ~~version 7.2.~~
			<li><var>Left</var> is identical to the <var>[[Substring (String function)\|Substring]]</var> method with <code>1</code> as its first argument. </li>
	</ul>		</ul>

	==Examples==		==Examples==
	<ol><li>The following statement places the left-most 5 bytes of <code>%x</code> into <code>%y</code>. If <code>%x</code> contains fewer than 6 bytes, then all of <code>%x</code> is copied into <code>%y</code>, padded on the right with blanks:		<ol>
			<li>The following statement places the left-most 5 bytes of <code>%x</code> into <code>%y</code>. If <code>%x</code> contains fewer than 6 bytes, then all of <code>%x</code> is copied into <code>%y</code>, padded on the right with blanks:
	<p class="code">%y = %x:left(5)		<p class="code">%y = %x:left(5)
	</p>		</p>
Line 36:		Line 41:
	==See also==		==See also==
	<ul>		<ul>
	<li>~~The~~ <var>[[UnicodeLeft (Unicode function)\|UnicodeLeft]]</var> ~~function.~~		<li><var>[[UnicodeLeft (Unicode function)\|UnicodeLeft]]</var> </li>
	<li>~~The~~ <var>[[Right (String function)\|Right]]</var> and <var>[[UnicodeRight (Unicode function)\|UnicodeRight]]</var> ~~functions.~~		<li><var>[[Right (String function)\|Right]]</var> and <var>[[UnicodeRight (Unicode function)\|UnicodeRight]]</var> </li>
	<li>~~The~~ <var>[[Center (String function)\|Center]]</var> ~~String function.~~		<li><var>[[Center (String function)\|Center]]</var> </li>
	</ul>		</ul>
	{{Template:String:Left footer}}		{{Template:String:Left footer}}

Dme: /* See also */

2017-07-05T11:37:21Z

JAL2 at 00:45, 24 February 2012

2012-02-24T00:45:13Z

← Older revision		Revision as of 00:45, 24 February 2012
Line 5:		Line 5:
	==Syntax==		==Syntax==
	{{Template:String:Left syntax}}		{{Template:String:Left syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 12:		Line 13:
	<td>The input, method object <var class="term">string</var> to which the method is applied.</td></tr>		<td>The input, method object <var class="term">string</var> to which the method is applied.</td></tr>
	<tr><th>length</th>		<tr><th>length</th>
	<td>The number of the left-most bytes to return. If the method object is shorter than the requested number of bytes, it is either padded to the requested length or the entire method object string is 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 bytes to return. If the method object is shorter than the requested number of bytes, it is either padded to the requested length or the entire method object string 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>This ~~is an~~ optional, ~~but~~ [[Notation conventions for methods#Named parameters\|name required]], parameter ~~and~~ is the character used to pad the method object string on the right if it is shorter than the requested length. <i>~~char~~</i> defaults to a blank. If set to null, no padding is applied.		<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], parameter is the character used to pad the method object string on the right if it is shorter than the requested length. <var class="term">c</var> defaults to a blank. If set to null, no padding is applied.
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul><li>The <var class="term">length</var> value must be a non-negative number. A negative number results in request cancellation.		<ul>
	<li>The <var ~~class="term"~~>~~pad~~</var> parameter value 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.		<li>The <var class="term">length</var> value must be a non-negative number. A negative number results in request cancellation.
	<li><var>Left</var> is identical to the [[Substring (String function)\|Substring]] method with a 1 for the first argument.		<li>The <var>Pad</var> parameter value 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.
	<li><var>Left</var> is available as of <var class="product">~~[[Sirius Mods\|~~Sirius Mods]]</var> version 7.2.</ul>		<li><var>Left</var> is identical to the <var>[[Substring (String function)\|Substring]]</var> method with a 1 for the first argument.
			<li><var>Left</var> is available as of <var class="product">Sirius Mods</var> version 7.2.
			</ul>

	==Examples==		==Examples==

JAL2: /* Syntax terms */

2012-02-24T00:38:44Z

Syntax terms

← Older revision		Revision as of 00:38, 24 February 2012
Line 14:		Line 14:
	<td>The number of the left-most bytes to return. If the method object is shorter than the requested number of bytes, it is either padded to the requested length or the entire method object string is 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 bytes to return. If the method object is shorter than the requested number of bytes, it is either padded to the requested length or the entire method object string is 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>This is an optional, but ~~<var class="term">nameRequired</var>~~, parameter and is the character used to pad the method object string on the right if it is shorter than the requested length. <i>char</i> defaults to a blank. If set to null, no padding is applied.		<td>This is an optional, but [[Notation conventions for methods#Named parameters\|name required]], parameter and is the character used to pad the method object string on the right if it is shorter than the requested length. <i>char</i> defaults to a blank. If set to null, no padding is applied.
	</table>		</table>

JAL2: /* Syntax terms */

2012-02-24T00:37:06Z

Syntax terms

← Older revision		Revision as of 00:37, 24 February 2012
Line 7:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~outStr~~</th>		<tr><th>%outString</th>
	<td>A variable to receive the string result of the <var>Left</var> method.</td></tr>		<td>A variable to receive the string result of the <var>Left</var> method.</td></tr>
	<tr><th>string</th>		<tr><th>string</th>

Dme: /* Examples */

2012-02-08T17:37:04Z

Examples

← Older revision		Revision as of 17:37, 8 February 2012
Line 24:		Line 24:

	==Examples==		==Examples==
	<ol><li>The following statement places the left-most 5 bytes of %x into %y. If %x ~~is shorter~~ than 6 bytes, then all of %x is copied into %y:		<ol><li>The following statement places the left-most 5 bytes of <code>%x</code> into <code>%y</code>. If <code>%x</code> contains fewer than 6 bytes, then all of <code>%x</code> is copied into <code>%y</code>, padded on the right with blanks:
	<p class="code">%y = %x:left(5)		<p class="code">%y = %x:left(5)
	</p>		</p>
	<li>The following statement displays ~~''''~~Wheeeee~~''''~~:		<li>The following statement displays <code>Wheeeee</code>:
	<p class="code">[[PrintText statement\|printText]] {'Wh':left(7, pad='e')}		<p class="code">[[PrintText statement\|printText]] {'Wh':left(7, pad='e')}
	</p></ol>		</p></ol>

JALWiccan: 1 revision

2011-05-24T21:10:33Z

1 revision

← Older revision	Revision as of 21:10, 24 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-24T21:10:32Z

1 revision

← Older revision		Revision as of 21:10, 24 May 2011
Line 19:		Line 19:
	==Usage notes==		==Usage notes==
	<ul><li>The <var class="term">length</var> value must be a non-negative number. A negative number results in request cancellation.		<ul><li>The <var class="term">length</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 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.		<li>The <var class="term">pad</var> parameter value 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.
	<li><var>Left</var> is identical to the [[Substring (String function)\|Substring]] method with a 1 for the first argument.		<li><var>Left</var> is identical to the [[Substring (String function)\|Substring]] method with a 1 for the first argument.
	<li><var>Left</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.</ul>		<li><var>Left</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.</ul>

JALWiccan: 1 revision

2011-05-04T17:46:26Z

1 revision

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

JALWiccan: 1 revision

2011-05-04T17:46:25Z

1 revision

← Older revision		Revision as of 17:46, 4 May 2011
Line 21:		Line 21:
	<li>The <var class="term">pad</var> parameter value 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.		<li>The <var class="term">pad</var> parameter value 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.
	<li><var>Left</var> is identical to the [[Substring (String function)\|Substring]] method with a 1 for the first argument.		<li><var>Left</var> is identical to the [[Substring (String function)\|Substring]] method with a 1 for the first argument.
	<li><var>Left</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> version 7.2.</ul>		<li><var>Left</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.</ul>

	==Examples==		==Examples==

← Older revision		Revision as of 11:37, 5 July 2017
Line 35:		Line 35:

	==See also==		==See also==
			<ul>
			<li>The <var>[[UnicodeLeft (Unicode function)\|UnicodeLeft]]</var> function.
			<li>The <var>[[Right (String function)\|Right]]</var> and <var>[[UnicodeRight (Unicode function)\|UnicodeRight]]</var> functions.
			<li>The <var>[[Center (String function)\|Center]]</var> String function.
			</ul>
	{{Template:String:Left footer}}		{{Template:String:Left footer}}