Utf8.sub

From GiderosMobile
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Available since: Gideros 2016.06
Class: utf8

Description

Returns the substring of s that starts at i and continues until j; i and j can be negative.

(string) = utf8.sub(s,i,j)

If j is absent, then it is assumed to be equal to -1 (which is the same as the string length). In particular, the call string.sub(s,1,j) returns a prefix of s with length j, and string.sub(s, -i) returns a suffix of s with length i.

If, after the translation of negative indices, i is less than 1, it is corrected to 1. If j is greater than the string length, it is corrected to that length.

If, after these corrections, i is greater than j, the function returns the empty string.

Parameters

s: (string) string
i: (number) start at position
j: (number) end at position optional

Return values

Returns (string) substring of s that starts at i and continues until j

Example

local in_str = "Hélène"
local out_str = utf8.sub(in_str, 1)