Left (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Full stop)
m (printtext)
Line 1: Line 1:
{{Template:String:Left subtitle}}
{{Template:String:Left subtitle}}


This [[Intrinsic classes|intrinsic]] function returns the left-most characters of the method object string, possibly padding it on the right.
The <var>Left</var> [[Intrinsic classes|intrinsic]] function returns the left-most characters of the method object string, possibly padding it on the right.


==Syntax==
==Syntax==
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>The <var>Left</var> method 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</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==
Line 28: Line 28:
</p>
</p>
<li>The following statement displays ''''Wheeeee'''':
<li>The following statement displays ''''Wheeeee'''':
<p class="code">printText {'Wh':left(7, pad='e')}
<p class="code">[[PrintText statement|printText]] {'Wh':left(7, pad='e')}
</p></ol>
</p></ol>


==See also==
==See also==
<ul><li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext|printText]]</var>.</ul>
{{Template:String:Left footer}}
{{Template:String:Left footer}}

Revision as of 08:09, 23 February 2011

The left-most characters of the string (String class)


The Left intrinsic function returns the left-most characters of the method object string, possibly padding it on the right.

Syntax

%outString = string:Left( length, [Pad= c])

Syntax terms

%outStr A variable to receive the string result of the Left method.
string The input, method object string to which the method is applied.
length 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 Pad parameter.
Pad This is an optional, but nameRequired, parameter and is the character used to pad the method object string on the right if it is shorter than the requested length. char defaults to a blank. If set to null, no padding is applied.

Usage notes

  • The length value must be a non-negative number. A negative number results in request cancellation.
  • The pad parameter value must be either null or a single character. A longer value results in request cancellation in "Sirius Mods" version 7.2 and in a compilation error in "Sirius Mods" 7.3 and higher.
  • Left is identical to the Substring method with a 1 for the first argument.
  • Left is available as of "Sirius Mods" version 7.2.

Examples

  1. 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:

    %y = %x:left(5)

  2. The following statement displays 'Wheeeee':

    printText {'Wh':left(7, pad='e')}

See also