Char (String function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (first pass, match syntax diagram to template and fix tags) |
||
| Line 1: | Line 1: | ||
{{Template:String:Char subtitle}} | {{Template:String:Char subtitle}} | ||
<var>Char</var> is an [[Intrinsic classes|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. | character array. | ||
==Syntax== | ==Syntax== | ||
{{Template:String:Char syntax}} | {{Template:String:Char syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%string</th> | ||
<td>A string variable to receive the result of the <var>Char</var> method. | <td>A string variable to receive the result of the <var>Char</var> method.</td></tr> | ||
<tr><th>string</th> | <tr><th><var class="term">string</var></th> | ||
<td>The string to which the method is applied. | <td>The <var class="term">string</var> to which the method is applied.</td></tr> | ||
<tr><th> | <tr><th>position</th> | ||
<td>The position in the method object string of the character you want to identify. | <td>The position in the method object <var class="term">string</var> of the character you want to identify. A <var class="term">position</var> of <code>1</code> finds the first character in the string.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<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. | |||
A | <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. | |||
</ul> | |||
===Example=== | ===Example=== | ||
The following statement displays the | <ol><li>The following statement displays the <code>s</code> character: | ||
<p class="code">[[Intrinsic classes#printtext|printText]] {'Conestoga':char(5)} | <p class="code">[[Intrinsic classes#printtext|printText]] {'Conestoga':char(5)} | ||
</p></ol> | |||
==See also== | ==See also== | ||
{{Template:String:Char footer}} | {{Template:String:Char footer}} | ||
Revision as of 04:47, 31 January 2011
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
| %string | 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
scharacter:printText {'Conestoga':char(5)}