Difference between revisions of "Utf8.len"
From GiderosMobile
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2016.06<br/> | '''Available since:''' Gideros 2016.06<br/> | ||
| + | '''Class:''' [[utf8]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | Returns the number of UTF-8 characters in string s that start between positions i and j (both inclusive) | + | Returns the number of UTF-8 characters in string ''s'' that start between positions ''i'' and ''j'' (both inclusive). |
| − | < | + | <syntaxhighlight lang="lua"> |
(number) = utf8.len(s,i,j) | (number) = utf8.len(s,i,j) | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
| + | The default for i is 1 and for j is -1. If it finds any invalid byte sequence, returns a false value plus the position of the first invalid byte. | ||
| + | |||
=== Parameters === | === Parameters === | ||
| − | '''s''': (string) | + | '''s''': (string) string<br/> |
| − | '''i''': (number) | + | '''i''': (number) start at position '''optional'''<br/> |
| − | '''j''': (number) | + | '''j''': (number) end at position '''optional'''<br/> |
| + | |||
=== Return values === | === Return values === | ||
'''Returns''' (number) number of characters<br/> | '''Returns''' (number) number of characters<br/> | ||
| + | |||
| + | === Example === | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | local str = "Hélène" | ||
| + | local str_length = utf8.len(str) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | {{Utf8}} | ||
Latest revision as of 20:36, 1 December 2023
Available since: Gideros 2016.06
Class: utf8
Description
Returns the number of UTF-8 characters in string s that start between positions i and j (both inclusive).
(number) = utf8.len(s,i,j)
The default for i is 1 and for j is -1. If it finds any invalid byte sequence, returns a false value plus the position of the first invalid byte.
Parameters
s: (string) string
i: (number) start at position optional
j: (number) end at position optional
Return values
Returns (number) number of characters
Example
local str = "Hélène"
local str_length = utf8.len(str)
