Char (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(30 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This [[Intrinsic classes|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
{{Template:String:Char subtitle}}
character array.
                                                                                                       
The Char function is available as of version 7.3 of the [[Sirius Mods]]. 
===Char syntax===   
  %outStr = string:Char(position) 
===Syntax Terms===                                                                                     
<dl>                                                                                                   
<dt>%outStr                                                                                           
<dd>A string variable to receive the result of the Char method.                                       
<dt>string                                                                                             
<dd>The string to which the method is applied.                                                         
<dt>location                                                                                           
<dd>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.                 
</dl>                                                                 
===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 (String function)|Substring]] function with a length argument of ''''1''''.           
===Example===                                                         
The following statement displays the ''''s'''' character:            
    [[Intrinsic classes#printtext|printText]] {'Conestoga':char(5)}


===See also===                                                                                       
<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
[[List of intrinsic String methods]]
character array.


==Syntax==
{{Template:String:Char syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%outString</th>
<td>A string variable to receive the result of the <var>Char</var> method.</td></tr>
<tr><th>string</th>
<td>The <var class="term">string</var> to which the method is applied.</td></tr>
<tr><th>position</th>
<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>


[[Category:Intrinsic String methods|Char function]]
==Usage notes==
[[Category:Intrinsic methods]]
<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.
[[Category:System methods]]
<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|Sirius Mods]]</var> version 7.3.
</ul>
 
==Example==
The following statement displays the <code>s</code> character:
<p class="code">[[PrintText statement|printText]] {'Conestoga':char(5)}
</p>
 
==See also==
{{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)}

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Char_(String_function)&oldid=593"