Char (String function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 8: | Line 8: | ||
{{Template:String:Char syntax}} | {{Template:String:Char syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%outStr </th> | ||
< | <td>A string variable to receive the result of the Char method. </td></tr> | ||
< | <tr><th>string </th> | ||
< | <td>The string to which the method is applied. </td></tr> | ||
< | <tr><th>location </th> | ||
< | <td>The position in the method object string of the character you want to identify. A value of 1 finds the first character in the string.</td></tr> | ||
A value of 1 finds the first character in the string. | </table> | ||
</ | |||
==Usage notes== | ==Usage notes== | ||
*The ''position'' value must be a non-negative, non-zero number; a zero or negative number results in request cancellation. | *The ''position'' value must be a non-negative, non-zero number; a zero or negative number results in request cancellation. | ||
Revision as of 05:39, 19 January 2011
The value at a specified position in the input string (String class)
This intrinsic function 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.
The Char function is available as of version 7.3 of the Sirius Mods.
Syntax
%outString = string:Char( position)
Syntax terms
| %outStr | A string variable to receive the result of the Char method. |
|---|---|
| string | The string to which the method is applied. |
| location | The position in the method object string of the character you want to identify. A value 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, the Char function returns the same value as the Substring function with a length argument of '1'.
Example
The following statement displays the 's' character:
printText {'Conestoga':char(5)}