Char (String function)

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

Float class String class Unicode class	List of Float methods List of String methods List of Unicode methods List of Intrinsic methods	Float methods syntax String methods syntax Unicode methods syntax
Notation conventions for methods