Difference between revisions of "Utf8.match"
From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2016.06<br/> === Description === Looks for the first match of pattern in the string s. If it finds one, then match returns the capture...") |
|||
(8 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 === | ||
− | Looks for the first match of pattern in the string s. If it finds one, then match returns the captures from the pattern; otherwise it returns nil. If pattern specifies no captures, then the whole match is returned. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative. | + | Looks for the first match of ''pattern'' in the string ''s''. |
− | + | <syntaxhighlight lang="lua"> | |
− | + | (strings) = utf8.match(s,pattern,init) | |
− | + | </syntaxhighlight> | |
− | '''s | + | |
− | '''pattern | + | If it finds one, then match returns the captures from the pattern; otherwise it returns nil. |
− | '''init | + | |
+ | If pattern specifies no captures, then the whole match is returned. | ||
+ | |||
+ | A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative. | ||
+ | |||
+ | === Parameters === | ||
+ | '''s''': (string) <br/> | ||
+ | '''pattern''': (string) <br/> | ||
+ | '''init''': (number) '''optional'''<br/> | ||
+ | |||
+ | === Return values === | ||
'''Returns''' (strings) captures<br/> | '''Returns''' (strings) captures<br/> | ||
+ | |||
+ | {{Utf8}} |
Latest revision as of 22:01, 1 December 2023
Available since: Gideros 2016.06
Class: utf8
Description
Looks for the first match of pattern in the string s.
(strings) = utf8.match(s,pattern,init)
If it finds one, then match returns the captures from the pattern; otherwise it returns nil.
If pattern specifies no captures, then the whole match is returned.
A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative.
Parameters
s: (string)
pattern: (string)
init: (number) optional
Return values
Returns (strings) captures