Char (String function)

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.

Char syntax

  %outStr = 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)}

See also

List of intrinsic String methods