Difference between revisions of "Utf8.sub"

From GiderosMobile
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2016.06<br/>
'''<translate>Available since</translate>:''' Gideros 2016.06<br/>
+
'''Class:''' [[utf8]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/utf8|utf8]]<br/>
+
 
=== <translate>Description</translate> ===
+
=== Description ===
<translate>Returns the substring of s that starts at i and continues until j; i and j can be negative. 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.
+
Returns the substring of ''s'' that starts at ''i'' and continues until ''j''; ''i'' and ''j'' can be negative.
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.</translate>
+
<syntaxhighlight lang="lua">
<source lang="lua">
 
 
(string) = utf8.sub(s,i,j)
 
(string) = utf8.sub(s,i,j)
</source>
+
</syntaxhighlight>
=== <translate>Parameters</translate> ===
+
 
'''s''': (string) <translate></translate> <br/>
+
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''.
'''i''': (number) <translate></translate> <br/>
+
 
'''j''': (number) <translate></translate> '''optional'''<br/>
+
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.
=== <translate>Return values</translate> ===
+
 
'''<translate>Returns</translate>''' (string) <translate>substring of s that starts at i and continues until j</translate><br/>
+
If, after these corrections, ''i'' is greater than ''j'', the function returns the empty string.
 +
 
 +
=== Parameters ===
 +
'''s''': (string) string<br/>
 +
'''i''': (number) start at position<br/>
 +
'''j''': (number) end at position '''optional'''<br/>
 +
 
 +
=== Return values ===
 +
'''Returns''' (string) substring of s that starts at i and continues until j<br/>
 +
 
 +
=== Example ===
 +
<syntaxhighlight lang="lua">
 +
local in_str = "Hélène"
 +
local out_str = utf8.sub(in_str, 1)
 +
</syntaxhighlight>
 +
 
 +
{{Utf8}}

Latest revision as of 20:36, 1 December 2023

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)