Char (String function): Difference between revisions
Jump to navigation
Jump to search
m (Full stop) |
m (→Example) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 19: | Line 19: | ||
<ul><li>The <var class="term">position</var> value must be a non-negative, non-zero number; a zero or negative number results in request cancellation. A <var class="term">length</var> value greater than the declared length of the output string results in request cancellation. | <ul><li>The <var class="term">position</var> value must be a non-negative, non-zero number; a zero or negative number results in request cancellation. A <var class="term">length</var> value greater than the declared length of the output string results in request cancellation. | ||
<li>For a given position, <var>Char</var> returns the same value as <var>[[Substring (String function)|Substring]]</var> with a length argument of <code>1</code>. | <li>For a given position, <var>Char</var> returns the same value as <var>[[Substring (String function)|Substring]]</var> with a length argument of <code>1</code>. | ||
<li><var>Char</var> is available as of <var class="product">Sirius Mods</var> version 7.3. | <li><var>Char</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> version 7.3. | ||
</ul> | </ul> | ||
==Example== | |||
The following statement displays the <code>s</code> character: | |||
<p class="code">[[ | <p class="code">[[PrintText statement|printText]] {'Conestoga':char(5)} | ||
</p | </p> | ||
==See also== | ==See also== | ||
{{Template:String:Char footer}} | {{Template:String:Char footer}} | ||
Latest revision as of 18:55, 2 November 2012
The value at a specified position in the input string (String class)
Char is an intrinsic function that returns the string value of the single byte at a specified position in the method object string; it treats the object string as a
character array.
Syntax
%outString = string:Char( position)
Syntax terms
| %outString | A string variable to receive the result of the Char method. |
|---|---|
| string | The string to which the method is applied. |
| position | The position in the method object string of the character you want to identify. A position of 1 finds the first character in the string. |
Usage notes
- The position value must be a non-negative, non-zero number; a zero or negative number results in request cancellation. A length value greater than the declared length of the output string results in request cancellation.
- For a given position, Char returns the same value as Substring with a length argument of
1. - Char is available as of Sirius Mods version 7.3.
Example
The following statement displays the s character:
printText {'Conestoga':char(5)}